Building Enterprise JavaScript Applications

Specifying the GET /salt endpoint

To ease our way into composing the full API specification, let's start with the simplest endpoint—GET /salt. To start off, we will add the paths root property, specify the path we are defining (/salt), and then the operation (get):

paths:  /salt:    get:

Under the get property, we will define an operation object. The full specification for the Operation Object can be found at github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#operation-object. For our use cases, we are concerned with the following properties:

• tags: This is used to logically group operations when displayed with Swagger UI.
• summary: A short summary of what the operation does.
• description: A more verbose description of the operation, ...