API
OpenAPI-спека
Машиночитаемый документ OpenAPI 3.1 — импортируйте его в свои инструменты.
Весь API описан машиночитаемым документом OpenAPI 3.1, который генерируется из схем маршрутов самого сервера — поэтому он никогда не расходится с реализацией.
URL спеки
/openapi/v1.json — актуальный документ. Живой сервер также
отдаёт его по адресу https://api.wardencore.ru/v1/openapi.json.
Как использовать
- Postman / Insomnia — Import → вставьте URL спеки, чтобы получить готовую коллекцию всех эндпоинтов с настроенной авторизацией.
- Генерация кода — скормите её openapi-generator или
openapi-typescript, чтобы получить типизированного клиента на вашем языке. - Контракты — документ описывает каждый ответ, включая общий конверт ошибки (
400,401,403,404,409,429,500,503,504).
Эндпоинты выкатываются постепенно
Документ перечисляет эндпоинты, доступные сегодня; он растёт по мере выката. Закрепляйтесь на версии (/v1) и переимпортируйте после обновлений — внутри версии мы только добавляем поля.