OpenAPI 3.1

This feature enables users to discover and understand REST APIs exposed by web applications and Liberty components that use the OpenAPI 3.0 specification.

Enable this feature

To enable the OpenAPI 3.1 feature, add the following element declaration into server.xml, inside the featureManager element:

<feature>openapi-3.1</feature>

Feature configuration elements

• administrator-role
• authCache
• authFilter
• authentication
• basicRegistry
• cache
• cacheManager
• cachingProvider
• classloader
• classloading
• jaasLoginContextEntry
• jaasLoginModule
• kerberos
• library
• ltpa
• quickStartSecurity
• reader-role
• trustAssociation

Standard API packages provided by this feature

• javax.servlet
• javax.servlet.annotation
• javax.servlet.descriptor
• javax.servlet.http

Liberty API packages provided by this feature

• com.ibm.websphere.security.auth.callback
• com.ibm.wsspi.security.auth.callback
• com.ibm.wsspi.security.common.auth.module
• com.ibm.wsspi.security.tai
• com.ibm.wsspi.security.token

Features that this feature enables

• distributedMap-1.0
• jaxrs-2.0
• jaxrs-2.1
• mpConfig-1.2
• mpConfig-1.3
• mpConfig-1.4
• mpOpenAPI-1.0
• servlet-3.0
• servlet-3.1
• servlet-4.0
• ssl-1.0

Supported Java versions

• JavaSE-1.8
• JavaSE-11.0
• JavaSE-17.0
• JavaSE-21.0
• JavaSE-24.0

Develop a feature that depends on this feature

If we are developing a feature that depends on this feature, include the following item in the Subsystem-Content header in your feature manifest file.

com.ibm.websphere.appserver.openapi-3.1; type="osgi.subsystem.feature"

SPI packages provided by this feature

• com.ibm.wsspi.openapi31