• Stars
    star
    115
  • Rank 305,853 (Top 7 %)
  • Language
    Java
  • License
    Apache License 2.0
  • Created over 6 years ago
  • Updated about 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

SmallRye implementation of Eclipse MicroProfile OpenAPI

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 and Data

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

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

    • data - Classes for use by unit tests

  • maven-plugin - Maven plugin that creates the OpenAPI Schema on build.

Configuration Extensions

  • Property Naming Strategy

    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.

  • Removal of unused schemas

    mp.openapi.extensions.smallrye.remove-unused-schemas.enable

    Set to true enable automatic removal of unused schemas from components/schemas in the OpenAPI model. Unused schemas will be removed following annotation scanning but prior to running any OASFilter that may be configured. Default value is false.

  • Automatic Schema Inheritance

    mp.openapi.extensions.smallrye.auto-inheritance

    Configures handling of schema inheritance. Allowed values include NONE (default), BOTH, and PARENT_ONLY.

    • NONE disables automatic schema inheritance. Parent class properties will be includes in the properties map of each child class unless @Schema(allOf = { …​ }) has been specified on the child class.

    • BOTH enables automatic schema inheritance by placing both the child and parent class within the child schema’s allOf property unless @Schema(allOf = { …​ }) has already been specified on the child class. BOTH processing can be selectively disabled on individual classes by setting @Schema(allOf = void.class) on the child class and no allOf will be set on the resulting schema - parent and child properties will be present in the child schema as if NONE were used.

    • PARENT_ONLY enables automatic schema inheritance by placing only the parent class within the child schema’s allOf property unless @Schema(allOf = { …​ }) has already been specified on the child class. PARENT_ONLY processing can be selectively disabled on individual classes by setting @Schema(allOf = void.class) on the child class and no allOf will be set on the resulting schema - parent and child properties will be present in the child schema as if NONE were used.

  • Duplicate Operation ID Behavior

    mp.openapi.extensions.smallrye.duplicateOperationIdBehavior

    Set to FAIL to abort in case of duplicate operationIds, set to WARN to log warnings when the build encounters duplicate operationIds. Default value is WARN.

  • Maximum Static File Size

    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.

More Repositories

1

smallrye-mutiny

An Intuitive Event-Driven Reactive Programming Library for Java
Java
813
star
2

jandex

Java Annotation Indexer
Java
394
star
3

smallrye-reactive-messaging

SmallRye Reactive Messaging
Java
239
star
4

smallrye-graphql

Implementation for MicroProfile GraphQL
Java
159
star
5

smallrye-config

SmallRye Config - A Java Configuration library
Java
157
star
6

smallrye-fault-tolerance

SmallRye implementation of MicroProfile Fault Tolerance: bulkheads, circuit breakers, fallbacks, rate limits, retries, timeouts, and more
Java
85
star
7

smallrye-mutiny-vertx-bindings

Smallrye Mutiny bindings for Eclipse Vert.x
Java
82
star
8

smallrye-stork

SmallRye Stork is a service discovery and client side-load balancing framework.
Java
76
star
9

smallrye-jwt

Java
75
star
10

smallrye-health

Java
52
star
11

smallrye-metrics

Java
39
star
12

smallrye-context-propagation

SmallRye implementation of MicroProfile Context Propagation
Java
30
star
13

smallrye-common

Common utilities for SmallRye
Java
21
star
14

smallrye-opentelemetry

SmallRye OpenTelemetry - A CDI and Jakarta REST implementation of OpenTelemetry Tracing
Java
21
star
15

smallrye-reactive-streams-operators

Implementation of the MicroProfile Reactive Streams Operators specification
Java
20
star
16

smallrye-opentracing

An MicroProfile-OpenTracing implementation
Java
19
star
17

smallrye-mutiny-zero

Zero-dependency Reactive Streams publishers library
Java
17
star
18

smallrye-async-api

Java
7
star
19

smallrye-event-sourcing

7
star
20

smallrye-llm

Experimentation around LLM and MicroProfile
Java
7
star
21

smallrye-rest-client

Implementation has been moved to https://github.com/resteasy/Resteasy/tree/master/resteasy-client-microprofile
Java
7
star
22

smallrye-graphql-client-intellij-plugin

Kotlin
5
star
23

smallrye-parent

Maven Parent POM
4
star
24

smallrye-beanbag

A simple programmatic bean container with support for creating a Maven resolver via integration with Eclipse SISU.
Java
3
star
25

smallrye-safer-annotations

Safer annotation constraints
Java
3
star
26

smallrye-antora-ui

Antora UI for the SmallRye documentation
CSS
2
star
27

smallrye-reactive-converters

Java
2
star
28

smallrye-testing

Testing utilities for all SmallRye projects
Java
1
star
29

smallrye-bom

1
star
30

smallrye-opentelemetry-sdk

Java
1
star
31

smallrye-jose

1
star
32

smallrye-converters

Java
1
star
33

smallrye-aesh

1
star
34

smallrye

SmallRye repo to handle cross projects work
1
star
35

smallrye-certificate-generator

Utilities to generated signed and self-signed certificates
Java
1
star