AIROBATIC Обсудить проект
Главная/Услуги/API сервисы и документация/OpenAPI-документирование

OpenAPI-документирование

OpenAPI-документирование

Создаём и поддерживаем документацию API по стандарту OpenAPI: спецификация становится источником правды, из которого рождаются документация, клиенты и тесты.

Что входит в работу

  • Описание API в формате OpenAPI/Swagger: методы, параметры, схемы ответов;
  • Интерактивная документация с примерами запросов и ответов;
  • Автогенерация клиентских SDK для нужных языков;
  • Песочница для тестирования без затрагивания продуктивных данных;
  • Проверка схем в CI — документация не расходится с реализацией.

Как мы работаем

  1. Инвентаризация — собираем существующие методы и фактические ответы;
  2. Описание — готовим спецификацию и подключённую к ней документацию;
  3. Поддержка — обновляем спецификацию вместе с изменениями API.

Ориентировочные цены — на странице Цены на услуги. Обсудить проект можно на странице контактов.

Внедрение

Поручите рутину AIROBATIC

Расскажите о задаче — подготовим сценарий внедрения, оценим сроки и покажем работу агента на вашем сервисе.