kbendick commented on pull request #3561: URL: https://github.com/apache/iceberg/pull/3561#issuecomment-984191129
> Have you thought about/considered something like https://github.com/eclipse/microprofile-open-api (just an example, but there are other libs available as well), which allows you to add OpenAPI annotations directly to your Java code, so that the OpenAPI spec+docs and the code are all at one place? In combination with JAX-RS annotations, everything that defines a REST endpoint would be combined at a single place and can be easier consumed/reasoned about by developers, rather than having the Swagger definitions and the endpoint implementations across multiple files. The `swagger.json|yaml` is then generated from the annotations, which we could then serve by a separate REST endpoint (it would basically show what you see when you upload the `swagger.yaml` to editor.swagger.io). I implemented some of these in a separate project (where I added Spring, as I couldn't figure out how to generate the OpenAPI doc from the eclipse microapi annotations - though they're essentially the same). It might make more sense to add it in a second pass when there's a bit more implemented. Presently it didn't feel like it provided a ton of value (and I'd need to figure out how to get it into the Iceberg build setup, as I used a separate project eventually so I could use Spring), though I can see how it could in the longer term. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
