API-документация и портал разработчика (OpenAPI 3.0)

Наш REST API разросся до сорока с лишним эндпоинтов, и на сегодня не задокументирован ни один из них. Разработчики, которые к нам интегрируются, по сути восстанавливают логику API по примерам запросов — это тормозит работу и порождает поток вопросов в поддержку. Мы хотим решить проблему основательно и заказать полную спецификацию OpenAPI 3.0 вместе с аккуратным порталом разработчика, в котором документацию можно и читать, и пробовать вживую.

Нам нужен исполнитель, сочетающий сильное техническое письмо с реальным опытом работы с API, потому что задача в равной мере про понятное объяснение и про точные схемы. Предстоит подготовить полную YAML-спецификацию OpenAPI 3.0 по всем эндпоинтам — со схемами запросов и ответов и кодами ошибок, — а затем превратить её в интерактивную документацию на Swagger UI или Redoc. Поверх справочника нужен гайд Getting Started с разбором аутентификации, лимитов, пагинации и обработки ошибок, а также готовые примеры кода на cURL, PHP и JavaScript для каждого ключевого эндпоинта. Дополняют картину Postman-коллекция и шаблон changelog для истории версий.

Мы предоставляем доступ к API, внутреннюю документацию кода и полный список эндпоинтов; готовую документацию ждём в течение 21 дня.

Результат:
— 1. OpenAPI 3.0 YAML-спецификация — все эндпоинты, схемы запросов/ответов, коды ошибок
— 2. Интерактивная документация (Swagger UI или Redoc)
— 3. Getting Started — аутентификация, лимиты, пагинация, ошибки
— 4. Примеры кода — cURL, PHP, JS для каждого ключевого эндпоинта
— 5. Changelog-шаблон
— 6. Postman-коллекция

Процесс:
— Мы предоставляем: доступ к API, документацию кода, список эндпоинтов
— Вы: полная документация за 21 день