API documentation is a technical content deliverable, containing instructions about how to effectively use and integrate with an API. It’s a manual containing all the information required to work with the API, with details about the functions, classes, return types, arguments and more, supported by tutorials and examples.
Here is how we can see how to use API:
For example:
1. Go on the menu -> orders page.
2. Turn on developer mode from the user name at the top right
3. Click "Add order" and the System starts to add here the requests and responses.
When you add an order, you have a live example of what you should use to add an order.
First all actions show in pop ups
Then when you click on the bell, you will see all actions and can click on them to see detailed info ->
Swagger
Swagger allows you to describe the structure of your APIs so that machines can read them.
The ability of APIs to describe their own structure is the root of all awesomeness in Swagger. Why is it so great? Well, by reading your API’s structure, we can automatically build beautiful and interactive API documentation. We can also automatically generate client libraries for your API in many languages and explore other possibilities like automated testing.
In the pro interface, click on the user name -> API Documentation
