Generating service information
Generating service information is a critical prerequisite for exposing services to wider audiences. It not only serves the purpose of helping consumers understand and test service calls, but it also allows them to stay current with version changes in the service definitions.
It did not take long for the open source community and software industry, in general, to standardize what service information should look like. In parallel, the tooling that helps generate this service information has evolved. Before looking at our tooling of choice, first, let’s understand the most commonly used API standard developed by the OpenAPI initiative.
OpenAPI specification
At the time of writing, the OpenAPI Specification v3.1.0 is the currently published version. The version number itself isn’t so important to our learning, but rather what the OpenAPI specification is and what it hopes to achieve.
The following is taken from the beginning of the...
