От исполнителя ждём YAML-спецификацию OpenAPI 3.0 со всеми методами, схемами запросов и ответов и кодами ошибок, а на её основе — интерактивную документацию на Swagger UI или Redoc, в которой методы можно не только читать, но и пробовать. Нужен раздел Getting Started с авторизацией, лимитами, пагинацией и обработкой ошибок, готовые примеры вызовов на cURL, PHP и JavaScript, экспорт Postman-коллекции и шаблон changelog для истории версий.
Доступ к API, внутренние заметки по коду и полный список эндпоинтов предоставим со своей стороны; ориентируемся на готовую документацию примерно за три недели. Важен именно опыт технической документации, а не только владение форматом OpenAPI.
Результат:
— OpenAPI 3.0 YAML-спецификация
— Интерактивная документация (Swagger UI/Redoc)
— Getting Started (авторизация, лимиты, ошибки)
— Примеры кода (cURL, PHP, JS)
— Postman-коллекция
— Changelog-шаблон
Требуется опыт в технической документации API.