Skip to main content

MicroProfile Open API 4.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

  • Incompatible changes:
    • None
  • API/SPI changes
    • New OpenAPI property jsonSchemaDialect 660
    • New methods added to Extensible: getExtension(String) and hasExtension(String) 666
    • Add @Target to @DependentRequired, @DependentSchema and @SchemaProperty where it was missing 676

Maven coordinates

Copy Code 


<dependency>

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

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

<version>4.1</version>

</dependency>

Scope

Finalized

Released

Details

Release Record
Javadocs
Spec PDF
Spec html
TCK

Compatible Implementations

Open Liberty

Product
Java version
Open Liberty cl250620250508-1902
Java 11, 17 and 21
Certification ResultsDownload
SmallRye OpenAPI 4.1.0-alpha2
Java 11, 17 and 21
Certification ResultsDownload

Ballots

Plan Review

The Specification Committee Ballot concluded successfully on  Mon, 3 Mar 2025  with the following results.

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

Release Review

The Specification Committee Ballot concluded successfully on  Fri, 6 Jun 2025  with the following results.

Corporate/Community Member Vote
Atlanta JUG no vote
Community (Emerson Castaneda) +1
Fujitsu +1
IBM +1
iJUG no vote
Microsoft +1
Oracle +1
Payara +1
Primeton +1
Red Hat +1
Tomitribe no vote
Binding total 8
Non-binding Votes
Garden State JUG 1
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
Close Menu