Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 2.46 KB

README.adoc

File metadata and controls

41 lines (30 loc) · 2.46 KB

badge Quality Gate Status License

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.

  • testsuite/tck - Test suite to run the implementation against the Eclipse MicroProfile OpenAPI TCK.

  • testsuite/extra - Extra integration tests not related to the TCK.

  • tools/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 or javax.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 the translate method is utilized.