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 гайд — аутентифікація, rate limits, пагінація, помилки
— 4. Приклади коду — cURL, PHP, JavaScript для кожного ключового ендпоінта
— 5. Changelog — шаблон для версійної історії
— 6. Postman-колекція

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