MicroProfile Open API 3.1

MicroProfile OpenAPI aims to provide a unified Java API for the OpenAPI v3.1 specification that all application developers can use to expose documentation for their REST APIs.

OpenAPI documentation can be automatically generated for REST applications written using the Jakarta RESTful Web Services API and application developers may also use annotations in their code to add additional detail to the documentation.

A low level model API is also provided to give application developers direct control over the document if needed, either to build up the document from scratch in code or to edit the generated document.

It’s also possible for the application developer to directly provide the OpenAPI document for their API instead.

Whether generated from the application or provided directly, the OpenAPI document is served to end users from the /openapi endpoint.

Weekly meeting: (UTC / US Eastern time).

Functional changes

Documentation is now produced in OpenAPI v3.1 format (previously v3.0)
A full list of the changes made in the 4.0 release can be found in the MP OpenAPI 4.0 milestone

Maven coordinates

Copy Code


<dependency>

 <groupId>org.eclipse.microprofile.openapi</groupId>

 <artifactId>microprofile-openapi-api</artifactId>

 <version>4.0</version>

</dependency>

Scope

Finalized

Released

Details

TCK

Compatible Implementations

Open Liberty

Product

Java version

Open Liberty - 24.0.0.9-beta-cl240920240801-0303

Java 11, 17 and 21

Certification Results Download

Ballots

Plan Review

The Specification Committee Ballot concluded successfully on Thu, 28 Mar 2024 with the following results.

Organization	Vote
Atlanta Java User Group (AJUG)	+1
IBM	+1
Red Hat	+1
Tomitribe	+1
Oracle	+1
iJUG	-1
Fujitsu	+1
Microsoft	+1
Primeton	+1
Payara	+1
Committer Representative (Emerson Castañeda)	+1

Total	10

Community	Vote


Total	0

Release Review

The Specification Committee Ballot concluded successfully on Mon, 19 Aug 2024 with the following results.

Corporate/Community Member	Vote
Atlanta JUG
Community (Emerson Castaneda)	+1
Fujitsu	+1
IBM	+1
iJUG
Microsoft
Oracle	+1
Payara	+1
Primeton	+1
Red Hat	+1
Tomitribe	+1
Binding total

Garden State JUG	+1

Non-binding Votes	8

Binding + non-binding total	9

Help optimize Enterprise Java for a microservices architecture.

Join the MicroProfile Google Group, peruse recent topics or create your own, and join in on the conversation. It's that easy!

JOIN THE DISCUSSION