From 3e3385d1eb9ac0a9405e748f5b688022de36a462 Mon Sep 17 00:00:00 2001 From: Egor Date: Sun, 28 Sep 2025 04:20:28 +0300 Subject: [PATCH] docs: explain enabling swagger ui --- docs/web-admin-integration.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/web-admin-integration.md b/docs/web-admin-integration.md index 4e922bc2..d5d2693d 100644 --- a/docs/web-admin-integration.md +++ b/docs/web-admin-integration.md @@ -29,6 +29,15 @@ API разворачивается вместе с ботом, использу > ⚠️ Если вы храните конфигурацию в Kubernetes/Ansible/других системах — не забудьте обновить секреты, чтобы бот видел эти переменные. +### Включение Swagger (интерактивной документации) + +Чтобы открыть интерфейс Swagger UI на `/docs`, убедитесь, что одновременно заданы две переменные окружения: + +1. `WEB_API_ENABLED=true` — включает само веб-API. +2. `WEB_API_DOCS_ENABLED=true` — публикует `/docs`, `/redoc` и `/openapi.json`. + +После изменения значений перезапустите бота. Интерфейс будет доступен по адресу `http://:/docs`. + ## 3. Подготовка базы данных 1. Убедитесь, что настройки БД верны (`DATABASE_URL` или параметры PostgreSQL/SQLite).