Спецификация OpenAPI

Машиночитаемое описание контракта — openapi.json.

Файл генерируется из тех же zod-схем, которыми бэкенд проверяет входящие запросы, поэтому умолчания и границы значений в нём те же самые, что применит сервер. Тест в репозитории отдельно следит, чтобы в спецификации был описан каждый существующий маршрут, и чтобы выложенный файл не отставал от кода.

Спецификацию можно скормить генератору клиента:

npx @openapitools/openapi-generator-cli generate \
  -i https://docs.odamiai.uz/openapi.json \
  -g typescript-fetch \
  -o ./src/odamiai

Или открыть в любом просмотрщике — Swagger UI, Redoc, Scalar, Insomnia, Postman. Версия спецификации — OpenAPI 3.1.

Аутентификация описана схемой ApiKey: заголовок X-API-Key, значение — сервисный ключ компании.