SmallRye OpenAPI
SmallRye OpenAPI is an implementation of Eclipse MicroProfile OpenAPI.
Instructions
Compile and install this project:
mvn clean install
Project structure
-
core - The core OpenAPI code, independent of entry point dependencies.
-
extension-jaxrs - The JAX-RS entry point. This module depends on JAX-RS and core.
-
extension-spring - The Spring entry point. This module depends on Spring and core.
-
extension-vertx - The Vert.x entry point. This module depends on Vert.x and core.
-
implementation - Implementation of the Eclipse MicroProfile OpenAPI specification. This just pulls in Core and the JAX-RS extension .
-
testsuite - Test Suites and Data
-
maven-plugin - Maven plugin that creates the OpenAPI Schema on build.
Configuration Extensions
-
mp.openapi.extensions.smallrye.property-naming-strategy
- define a naming strategy to be used globally for all schema properties. Set to one of the following:-
A standard JSON-B naming strategy (listed in
jakarta.json.bind.config.PropertyNamingStrategy
/javax.json.bind.config.PropertyNamingStrategy
) -
A fully-qualified class name of an implementation of a JSON-B property naming strategy (
jakarta.json.bind.config.PropertyNamingStrategy
orjavax.json.bind.config.PropertyNamingStrategy
) -
A fully-qualified class name of an implementation of a Jackson property naming strategy base class (
com.fasterxml.jackson.databind.PropertyNamingStrategies.NamingBase
). Only thetranslate
method is utilized.
-
-
mp.openapi.extensions.smallrye.remove-unused-schemas.enable
- Set totrue
enable automatic removal of unused schemas fromcomponents/schemas
in the OpenAPI model. Unused schemas will be removed following annotation scanning but prior to running anyOASFilter
that may be configured. Default value isfalse
. -
mp.openapi.extensions.smallrye.duplicateOperationIdBehavior
- Set toFAIL
to abort in case of duplicate operationIds, set toWARN
to log warnings when the build encounters duplicate operationIds. Default value isWARN
. -
mp.openapi.extensions.smallrye.maximumStaticFileSize
- Set this value in order to change the maximum threshold for processed static files, when generating model from them. If not set, it will default to 3 MB.