Как расписать документацию для rest api?

Question

[nuralykopbosyn23]

По ссылке ниже предоставлен пример настройки программы лояльности, которые в будущем будут необходимы для модуля «Кассы», со стороны заказчика доступна следующая информация:
1) Добавить настройку по созданию, редактированию, удалению и отображению акций в настройках системы.
2) Акции бывают только 2 типов: скидка и кэшбек.
3) Активный кэшбек должен быть только один.
4) Акции можно привязать только к определенным услугам.

Ссылка на дизайн:
https://bit.ly/2VlUTRk

Вам необходимо сделать описание и декомпозицию задачи отдельно для front-end и back-end разработчиков с детализированным описанием, технической документацией для Rest-API и сценариями тестирования.

Прилетела такая задача. Раньше с rest api вообще не имел дело. Погуглил. Понял для чего она. Не понял как её теперь расписывать. Сможете показать пример на этом задании?

Спасибо!

Answer 1

[Максим]

Почитайте про swagger.
Конкретно пример технической документации апи есть там же в песочнице - Swagger Petstore.