Other specifications

There are several other specifications that we will touch upon only briefly in this section. This is meant to give you a quick introduction to their functionality.

OpenAPI

This specification supplies a Java API for OpenAPI, a specification that allows developers to expose their API documentation.

It holds no less than 46 annotations that can be added to your code and allows you to completely describe your API, resources, parameters, and return values.

The following example has been taken from the official MicroProfile OpenAPI specification documentation:

@GET
@Path("/{username}")
@Operation(summary = "Get user by user name")
@APIResponse(description = "The user",
             content = @Content(mediaType = "application/json",
                    ...