Documentation

There are many specifications as well as tools that follow those specifications for documenting APIs. The 2 most common API Description Languages are OpenAPI (previously known as the Swagger Specifications) and RAML (RESTful API Modeling Language). The OpenAPI specification created by Swagger is the most common and most popular among the API Description Languages. We will be using the OpenAPI specification in our application to document our RESTful API later in this book.

Both the OpenAPI and RAML official specifications and documentations are available online. Take some time to read through some of it to decide which would suit your documentation style.

https://swagger.io/specificationswagger.io

https://swagger.io/specification

raml-spec/raml-10.md at master · raml-org/raml-specGitHub

https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md