How to write documentation for rest api?

Question

RESTful API

The link below provides an example of setting up a loyalty program that will be required for the Cashier module in the future, the following information is available from the customer's side:
1) Add a setting for creating, editing, deleting and displaying promotions in the system settings.
2) There are only 2 types of promotions: discount and cashback.
3) There should be only one active cashback.
4) Promotions can only be linked to certain services.

Design link:
https://bit.ly/2VlUTRk

You need to make a description and decomposition of the task separately for front-end and back-end developers with a detailed description, technical documentation for Rest-API and test scenarios.

Such a task has arrived. Previously, I did not deal with rest api at all. Googled it. I understand what it is for. I do not understand how to paint it now. Can you show an example for this assignment?

Thank you!

Answer 1

Read about swagger .
Specifically, an example of api technical documentation is also in the sandbox - Swagger Petstore .