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 день