tech/sendico
2
0
Fork 0
Code Issues 32 Pull Requests Actions Packages Projects Releases Wiki Activity

added api docs #548

Merged
tech merged 2 commits from SEND056 into main 2026-02-25 00:39:13 +00:00
Conversation 2 Commits 2 Files Changed 86 +4 -29
3 changed files with 4 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit d70d9e84c9 - Show all commits

5
ci/dev/Caddyfile.dev
View File

@@ -8,6 +8,7 @@
:80 {
vars static_root /usr/share/pweb
vars docs_root /usr/share/docs
encode zstd gzip
@@ -45,14 +46,14 @@
}
handle /docs/ {
root * {vars.static_root}/docs
root * {vars.docs_root}
rewrite * /doc.html
file_server
header Cache-Control "no-cache"
}
handle_path /docs/* {
tech marked this conversation as resolved
tech commented 2026-02-24 20:15:57 +00:00
Review
Copy Link

корректная настройка, но путь надо перенастроить с папки приложения на отдельную папку документации

корректная настройка, но путь надо перенастроить с папки приложения на отдельную папку документации
root * {vars.static_root}/docs
root * {vars.docs_root}
file_server
header Cache-Control "no-cache"
}

2
ci/dev/frontend.dockerfile
View File

@@ -48,7 +48,7 @@ FROM caddy:alpine AS runtime
WORKDIR /usr/share/pweb
COPY --from=web_builder /home/flutteruser/app/pweb/build/web /usr/share/pweb
COPY interface /usr/share/pweb/docs
COPY interface /usr/share/docs
tech marked this conversation as resolved Outdated
tech commented 2026-02-24 20:04:16 +00:00
Outdated
Review
Copy Link

Ты подкладываешь исходники документации в скомпилированный код flutter. Так лучше не делать, потому что внутри папки может оказаться случайно папка с таким же именем. И если туда насыпать неожиданного, то может поломаться фронт.

Лучше класть документацию в /usr/share/docs . И на нее же настраивать Caddy (завести еще одну переменную, куда положить ссылку на контент docs).

Ты подкладываешь исходники документации в скомпилированный код flutter. Так лучше не делать, потому что внутри папки может оказаться случайно папка с таким же именем. И если туда насыпать неожиданного, то может поломаться фронт. Лучше класть документацию в /usr/share/docs . И на нее же настраивать Caddy (завести еще одну переменную, куда положить ссылку на контент docs).
# Copy Caddy config (will be mounted from host)
# COPY frontend/pweb/caddy/Caddyfile /etc/caddy/Caddyfile

26
interface/sw.html
View File

@@ -1,26 +0,0 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Sendico API Docs (Swagger UI)</title>
<link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist@5/swagger-ui.css" />
<style>
html, body { margin: 0; height: 100%; }
#swagger-ui { height: 100%; }
</style>
</head>
<body>
<div id="swagger-ui"></div>
<script src="https://unpkg.com/swagger-ui-dist@5/swagger-ui-bundle.js"></script>
<script>
window.ui = SwaggerUIBundle({
url: './api.yaml',
dom_id: '#swagger-ui',
deepLinking: true,
presets: [SwaggerUIBundle.presets.apis],
layout: 'BaseLayout'
});
</script>
</body>
</html>