Разработка сайта документации для существующего JSON API

1 000 руб.за час
25 февраля 2021, 17:18 • 6 откликов • 54 просмотра
У нашего приложения есть публичный API, которым могут пользоваться сторонние пользователи. Текущая версия документации реализована через docs.apiary.io и обладает рядом недостатков:

1. Плохо кастомизируется
2. Плохо расширяется
3. Сложно автоматизировать
4. Хостится не у нас.


Мы хотим реализовать новую версию документации лишенную этих минусов. Нам подойдет любой конструктор статических сайтов или фреймворк для документации API (например: gatsby или https://www.docz.site/). У текущего API нет swagger схемы или любого другого автоматического описания, но в будущем это может быть добавлено. Всего около 20 эндпоинтов.


От исполнителя требуется:

1. Предложить несколько вариантов реализации (на каком именно джижке и т.п.)
2. Обсудить сроки поставки
3. Собрать описание эндпоинтов и добавить их в документацию
4. Будет плюсом настройка CD (CircleCI, Docker)