smallrye / smallrye-open-api

SmallRye implementation of Eclipse MicroProfile OpenAPI
Apache License 2.0
113 stars 87 forks source link

Introduce more usable public API #1762

Closed MikeEdgar closed 2 months ago

MikeEdgar commented 4 months ago

Currently, platforms integrating with smallrye-open-api make use of some combination of at least the following classes:

Many of the classes provide overloaded static methods that makes it hard to make modifications without studying each client.

We should have a single unified public "builder" style API that users access to generate OpenAPI models and de-/serialize them to/from YAML or JSON. It is a goal to limit exposing internal smallrye-open-api types in this new API.