hohwille
commented
4 years ago Some hints to implement this feature:
- currently
generatemojo can only generate HTML documentation out of the service-metadata. - However, it works as following: 1. analyse the code to generate metadata, 2. generate HTML documentation out of metadata.
- This desgin allows to extend step 1. to also support other things than JAX-RS like spring-mvc for instance or JAX-WS (see #26). And what is more important here instead of 2. you could also generate a
swagger.json/OpenApi.jsonfile out of the metadata. - So for the feature you would create a new Mojo by copying ServiceDocGenReport and replacing 2. with OpenApi generation - replace
@Mojo( name = "generate" ...with something like@Mojo( name = "openapi" - Later refactor a super-class for both Mojos to put the shared code in and avoid code duplication.
- BTW: The HTML documentation generation happens via Velocity templating engine. This template is used: https://github.com/mojohaus/servicedocgen-maven-plugin/blob/master/src/main/resources/org/codehaus/mojo/servicedocgen/generation/velocity/Service-Documentation.html.vm
- Maybe it is even possible to just add a
OpenApi.json.vmfile and generate the JSON with it. Then the only thing to do additionally would be to reconfigure the template fromService-Documentation.html.vmtoOpenApi.json.vmand you are done - Already configurable here: https://github.com/mojohaus/servicedocgen-maven-plugin/blob/master/src/main/java/org/codehaus/mojo/servicedocgen/ServiceDocGenReport.java#L100
It would be a nice feature extension to generate an OpenAPI specification (aka swagger.json). The collected metadata already contains most information. Creating a new Mojo that allows to write this as JSON to the disc should be no big deal...