Гарантия возврата
Вернем деньги, если что-то пойдет не так.
Алексей
Алексей
Верифицированный пользователь
Чат откроется после оплаты
Стоимость услуги
3 900 rub

Срок выполнения

2 дня

Гарантия возврата
Вернем деньги, если что-то пойдет не так.
Алексей
Алексей
Верифицированный пользователь

Оформлю документацию 10 методов API в OpenAPI

Подготовлю спецификацию OpenAPI 3.0 для существующего REST API на основании предоставленных материалов. Объём: до 10 методов, до 10 схем данных, до 15 полей в схеме, один сервер и один способ авторизации. Опишу параметры, JSON-запросы, успешные ответы и до 2 ошибок на метод; добавлю примеры без секретов. Проверю синтаксис спецификации и отображение в Swagger Editor. Передам YAML и инструкцию просмотра. Разработка API, восстановление недокументированной логики по исходному коду, функциональное тестирование и размещение документации на сервере не входят. Правки в рамках заказа: ошибки моей работы и отклонения от описанного результата исправляю без ограничения числа обращений до приёмки. Изменения по пожеланиям в исходном объёме — 2 круга, до 5 замечаний в каждом. Новые функции и увеличение объёма не входят. Платные лицензии, хостинг и тарифы внешних сервисов при необходимости предоставляет и оплачивает заказчик.

Заказчик получит:

Спецификация OpenAPI YAML для 10 методов с примерами и инструкция просмотра.

До начала работы заказчик должен предоставить:

Список до 10 методов, параметры, схемы и примеры запросов/ответов, коды ошибок, описание авторизации. Только тестовые примеры без токенов и персональных данных.