OpenAPI
OpenAPI is a standard from the OpenAPI Initiative that describes HTTP APIs and is the de facto standard for REST APIs.
It imparts a detailed description of all the URLs, methods, parameters, resources, entities, and serialization mechanisms available while also providing examples of how to use the API in code.
In this section, we’ll explore the basic shape of OpenAPI and the main things you need to look at to understand an API. However, we won’t get into the details of the OpenAPI format. Instead, I’ll help you understand an API through its OpenAPI documentation.
We’ll explore how to document APIs using OpenAPI in Chapter 11.
For now, let’s talk more about the OpenAPI file and its format.
The OpenAPI file
The OpenAPI file is a YAML Ain’t Markup Language (YAML) file containing general API information and a list of paths. Each path represents a URL in your API; you can have a set of accepted methods for that URL...
