Introducing MicroProfile OpenAPI 1.0

OpenAPI is a specification that standardises how developers describe REST APIs so that it is easy to generate API documentation from the APIs themselves. You can now generate this documentation from your microservice REST APIs using MicroProfile OpenAPI and Open Liberty 18.0.0.1 with the mpOpenAPI-1.0 feature. This is the implementation of the MicroProfile OpenAPI 1.0 specification released in December 2017.

State of the API Economy

If you have written REST APIs in the last few years, chances are you were asked to provide the Swagger file that described your APIs. Conversely if you wanted to use a REST API from another provider you would have been given their Swagger file.

The Swagger specification certainly rose above other similar standards, such as API Blueprint and RAML, but it was still being governed by a single entity. That was until 2016, when the main players in the API industry got together and formed the OpenAPI Initiative. The Swagger v2 specification was donated to the OpenAPI Initiative and renamed to OpenAPI v2, and in July 26, 2017 a new, more powerful specification was released: OpenAPI v3

The consortium governance model of this new specification meant that new tools vendors started to emerge with libraries and SDKs. Java developers had a choice from many different annotations or libraries to include in their application – but none that was officially supported by any of the major Java application server vendors, which affected portability and consistency. There was an increasing need for an official Java programming model that was supported by different vendors and integrated with other modern libraries.

Enter MicroProfile OpenAPI

Similarly to how the Swagger specification was used as the base for a community-driven specification, the Java libraries for Swagger were used as the base for the MicroProfile community programming model for OpenAPI v3: MicroProfile OpenAPI. This specification outlined an official set of annotations and interfaces that allow developers to successfully generate OpenAPI v3 documentation for their Java RESTful APIs.

The following diagram provides an overview of the MicroProfile OpenAPI support in Open Liberty, via the mpOpenAPI-1.0 feature.

MP OpenAPI Architecture

One of the key aspects of the MicroProfile OpenAPI specification is the requirement to produce a valid OpenAPI document from pure JAX-RS 2.0 applications. This means that Open Liberty processes all the relevant JAX-RS annotations (such as @Path and @Consumes) as well as Java objects (POJOs) used as input or output to JAX-RS operations. This is a good place to start for application developers that are new to OpenAPI: just deploy your existing JAX-RS application into Open Liberty and check out the output from /openapi!

The application developer then has a few choices to provide input for the generation of the resulting OpenAPI document:

  1. Augment those JAX-RS annotations with the OpenAPI Annotations. Using annotations means developers don’t have to re-write the portions of the OpenAPI document that are already covered by the JAX-RS framework (e.g. the HTTP method of an operation). This is the most common path, so definitely check out some of the examples to get familiar with some of these annotations and their generated output.

  2. Take the initial output from /openapi as a starting point to document your APIs via Static OpenAPI files. It’s worth mentioning that these static files can also be written before any code, which is an approach often adopted by enterprises that want to lock-in the contract of the API. In this case, we refer to the OpenAPI document as the "source of truth", by which the client and provider must abide.

  3. Use the API interfaces to provide a bootstrap (or complete) OpenAPI model tree.

  4. Additionally, a Filter is described which can update the OpenAPI model after it has been built from the previously described documentation mechanisms.

All of these mechanisms are combined to form the valid OpenAPI v3 document from /openapi.

OpenAPI UI

A very important value-add from Open Liberty is the native OpenAPI UI that it ships out of the box! This UI is built from the Open Source Swagger UI and renders the generated /openapi document into a very user friendly page. One of the best features is the ability to Try out each endpoint, making an invocation to the back-end straight from the UI.

The UI, available from the endpoint /openapi/ui can also be customized beyond the default look-and-feel.

MP OpenAPI UI

Additional Information

You are now ready to try out an application that has MicroProfile OpenAPI enabled! Just head over to our sample app project and follow the instructions to build an Open Liberty docker container with MicroProfile OpenAPI!

For more information on the MicroProfile OpenAPI specification, see the official MicroProfile OpenAPI 1.0 release. For further documentation about the mpOpenAPI-1.0 feature, check out the official topic.

Get involved in the MicroProfile community at: https://microprofile.io

Share this post: