Documenting cloud native applications using MicroProfile OpenAPI
As mentioned in Chapter 2, How Does MicroProfile Fit into Cloud-Native Applications?, you might have difficulties remembering what functionalities a particular cloud-native application has when you have tens or hundreds of cloud-native applications to manage. You will need to provide documentation for them. With documented endpoints, some clients can discover and invoke them.
MicroProfile OpenAPI (source code at https://github.com/eclipse/microprofile-open-api/) provides a set of annotations and programming models that enable you to document cloud-native applications and then produce documents conforming to the OpenAPI v3 specification (https://github.com/OAI/OpenAPI-Specification). The OpenAPI v3 specification defines a set of interfaces for documenting and exposing RESTful APIs. MicroProfile OpenAPI adopts the OpenAPI Specification and further simplifies the OpenAPI model so that it is much easier for Java developers...