OpenAPI 3.0

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

Enabling this feature

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

<feature>openapi-3.0</feature>

Feature configuration elements

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

Third-party API packages provided by this feature

io.swagger.oas.annotations
io.swagger.oas.annotations.callbacks
io.swagger.oas.annotations.enums
io.swagger.oas.annotations.extensions
io.swagger.oas.annotations.headers
io.swagger.oas.annotations.info
io.swagger.oas.annotations.links
io.swagger.oas.annotations.media
io.swagger.oas.annotations.parameters
io.swagger.oas.annotations.responses
io.swagger.oas.annotations.security
io.swagger.oas.annotations.servers
io.swagger.oas.annotations.tags
io.swagger.oas.integration
io.swagger.oas.models
io.swagger.oas.models.callbacks
io.swagger.oas.models.examples
io.swagger.oas.models.headers
io.swagger.oas.models.info
io.swagger.oas.models.links
io.swagger.oas.models.media
io.swagger.oas.models.parameters
io.swagger.oas.models.responses
io.swagger.oas.models.security
io.swagger.oas.models.servers
io.swagger.oas.models.tags

Features that this feature enables

Supported Java versions

JavaSE-1.8
JavaSE-11.0
JavaSE-17.0
JavaSE-21.0
JavaSE-22.0

Developing a feature that depends on this feature

If you 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.0; type="osgi.subsystem.feature"

SPI packages provided by this feature

com.ibm.wsspi.openapi