OpenAPI — интерактивная спецификация¶

Reference · OpenAPI 3.1 · источник: FastAPI create_app().openapi()

Файлы¶

Swagger UI (lab / internal)¶

На app VM backend отдаёт интерактивный Swagger:

• http://10.0.9.111:8080/docs — Swagger UI
• http://10.0.9.111:8080/redoc — ReDoc
• http://10.0.9.111:8080/openapi.json — JSON

Через nginx SPA (https://scope.kz) эти пути не проксируются — только /api/* и /ws/*.

Просмотр на docs.scope.kz¶

Ниже — встроенный ReDoc для статической копии openapi.json (обновляется скриптом экспорта).

Обновление¶

./infra/scripts/docs-export-openapi.sh
cd infra/docker && docker compose -f docker-compose.dev.yml --profile docs up -d --build docs

Переменная OPENAPI_URL (по умолчанию http://127.0.0.1:8080/openapi.json) переопределяет источник при live export.