Understanding Micronaut's OpenAPI

APIs are generic languages for machines to interact with each other. Having an API definition ensures there is a formalized specification in place. All APIs should have a specification, which improves development efficiency and reduces interaction problems. The specifications act as documentation that helps third-party developers or systems to understand the service easily. Micronaut supports OpenAPI (Swagger) YAML at compile time. We learned about this in Chapter 7, Handling Microservices Concerns. The OpenAPI Initiative (OAI) was previously known as the Swagger Specification. It is used to create machine-readable interface files for describing, producing, consuming, and visualizing RESTful web services. The OAI is now a consortium that promotes a vendor-neutral description format. OpenAPI is also called a public API, which is publicly made available to software developers and companies. Open APIs can be implemented with REST APIs or SOAP APIs...