Документація·OpenAPI та Postman
⚙

OpenAPI та Postman

Live OpenAPI spec, Scalar viewer, Postman колекція — генеруйте клієнтів, mock-сервери, що завгодно.

OpenAPI spec

Канонічна OpenAPI 3.1 spec доступна live за адресою:

https://api.eveses.com/docs/openapi.yaml

Її регенерується при кожному деплої з реальних route handlers, тому вона ніколи не розходиться з production-поведінкою. Використовуйте її щоб:

  • Згенерувати клієнтів у будь-якій мові (openapi-generator-cli generate -i openapi.yaml -g python)
  • Підняти mock-сервер (prism mock openapi.yaml)
  • Зробити diff проти останньої vendored-копії в CI

Перегляд

Scalar viewer рендерить spec як інтерактивну документацію за адресою:

https://api.eveses.com/docs

Пробуйте ендпоінти прямо в браузері, вставивши ваш API-ключ у auth box.

Postman

Імпортуйте колекцію (згенеровану з тієї ж spec):

https://api.eveses.com/docs/eveses.postman_collection.json

Вона постачається з env-змінними eveses_api_key і eveses_base_url. Встановіть їх раз — усі запити будуть pre-filled.

Версіонування

Поточна spec — v1. Ми ніколи не ламаємо v1 ендпоінти — додавання backward-compatible. Майбутній v2 буде існувати поряд з v1 щонайменше 12 місяців до deprecation.

Підпишіться на /changelog/api щоб дізнаватись про додавання.