An API needs to be documented to be usable. Indeed, when you want to use an API, you will not want to read a complete manual beforehand. It is better to have a self-explanatory and intuitive API.
To help with the documentation and testing part, there is a useful framework: Swagger.
Swagger not only helps to write the documentation; it also allows you to test the API directly while reading the documentation. In order to visualize the documentation with the Swagger UI, you must first declare a specification file, in JSON or YAML format. This specification file defines all of the URLs and data models that constitute your API.
There are multiple ways to use Swagger, as follows:
- You can write the specification of your API using the Swagger Editor, and Swagger will generate a skeleton of the code for you
- You can add the Swagger specification directly in the
route.conffile - You can add annotations in your code to generate the Swagger
specificationfile
For our project, we are going to generate...