helidon-io / helidon

Java libraries for writing microservices
https://helidon.io
Apache License 2.0
3.52k stars 565 forks source link

Support generating OpenAPI specification in SE #3231

Open romain-grecourt opened 3 years ago

romain-grecourt commented 3 years ago

Support Generating OpenAPI documents for Helidon SE based application.

Some ideas:

Introspection is limited because of the programmatic model of SE. Hints are required from the user, we will need a way to specify additional metadata, with annotations or perhaps special objects passed to the routing.

E.g.

Supporting the MicroProfile OpenAPI annotations could converge the MP and SE support. We could decide to support build-time only for Helidon SE.

graemerocher commented 3 years ago

You might want to look at https://github.com/micronaut-projects/micronaut-openapi/ for inspiration