Письменник технічної документації API

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

Ми шукаємо людину, яка поєднує сильне технічне написання з реальним практичним досвідом API, оскільки ця робота полягає як у ясному поясненні, так і в точних схемах. Ви створите повну специфікацію OpenAPI 3.0 YAML, яка охоплює кожну кінцеву точку, її схеми запитів та відповідей та коди помилок, потім перетворите це на інтерактивні документи, розміщені за допомогою Swagger UI або Redoc. Крім довідника нам потрібен посібник з практичного керування, який проведе через автентифікацію, обмеження частоти, пагінацію та обробку помилок, плюс приклади коду копіювання-вставки в cURL, PHP та JavaScript для кожної основної кінцевої точки. Завершіть це колекцією Postman та шаблоном журналу змін для історії версій.

Ми надамо доступ API, нашу існуючу внутрішню документацію кодексу та повний список кінцевих точок; ми очікуємо завершену документацію протягом двадцяти одного дня.

Результати:
— 1. OpenAPI 3.0 YAML специфікація — всі кінцеві точки, схеми запитів/відповідей, коди помилок
— 2. Інтерактивна документація API — розміщена сторінка Swagger UI або Redoc
— 3. Посібник з практичного керування — автентифікація, обмеження частоти, пагінація, помилки
— 4. Приклади коду — cURL, PHP, JavaScript для кожної основної кінцевої точки
— 5. Журнал змін — шаблон історії версій
— 6. Експорт колекції Postman

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