Документация·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 чтобы узнавать о добавлениях.