av
59ec613184
- 20 задач: 8 высоких, 9 средних, 3 низких; две заведены идеями — сутки при смене часового пояса и пересекающиеся источники одной метрики - план сведён к порядку и его обоснованию, единицы работы переехали в беклог
25 lines
1.7 KiB
Markdown
25 lines
1.7 KiB
Markdown
# OpenAPI-спека и Swagger UI
|
|
|
|
**Приоритет:** высокий
|
|
|
|
Потребителей три, и один из них — агент, который читает контракт машиной.
|
|
Пересказывать форму ответа в чате не годится, а самоописание из плана покрывает
|
|
только **содержимое** метрик; форма конверта, коды ответов и параметры запроса —
|
|
это OpenAPI.
|
|
|
|
Заодно снимает вопрос, чем быть «схеме контракта API» из раздела самоописания:
|
|
ею и будет OpenAPI-документ, а не собственный формат.
|
|
|
|
Шаги:
|
|
- спека OpenAPI 3.1 на приём, каталог, точки, тренировки, записи, `/stats`;
|
|
- Swagger UI на отдельном пути, отдаётся самим сервисом (без внешних CDN —
|
|
он должен работать в локальной сети без интернета);
|
|
- проверка актуальности спеки в гейте: контракт разъезжается молча.
|
|
|
|
Готово, когда по спеке можно сгенерировать клиент, а Swagger UI открывается
|
|
локально и выполняет запрос к живому сервису.
|
|
|
|
Развилка на решение: спека пишется руками как источник истины или выводится из
|
|
кода. Для маленького API рукописная спека честнее — но это стоит обсудить.
|
|
|