HTTP API: Swagger UI и ReDoc¶
Сервис tinvest-api (FastAPI) при запуске публикует машиночитаемую спецификацию OpenAPI 3 и две страницы автодокументации:
| Интерфейс | Путь (внутри контейнера / процесса) | Пример при пробросе порта из docker-compose |
|---|---|---|
| Swagger UI | /docs |
http://localhost:38000/docs |
| ReDoc | /redoc |
http://localhost:38000/redoc |
| OpenAPI JSON | /openapi.json |
http://localhost:38000/openapi.json |
На страницах /docs и /redoc видны:
- описание эндпоинтов, параметров запроса и схем ответов;
- возможность выполнить запрос из браузера (Swagger).
Здоровье сервиса без обращения к БД: GET /health.
Данные сигналов читаются из Postgres; при недоступности БД сервис при старте будет ждать подключения (см. POSTGRES_STARTUP_* в конфигурации).