GuentherJulian
commented
2 years ago Some high-level comments on it.
- I like that you showed the options a project might have, but options also come with the burden of taking a decision. That's what devonfw wants to get rid of for stupid things or at least give clear guidance on the decision. So, we should provide a short comparison at the start enabling people to make their decision easily. Additionally, we should claim, that if there is no clarity of the decision to take choice X - on quarkus this might be smallrye, on spring that might be servicedocgen.
- Why don't we provide a short devonfw-tutorials/tutorials tutorial for each of the options. It#s a quite short tutorial, which anyhow easily shows how it works and also shows hands-on how the swagger UI looks like for the cases where it can be generated. Also the people can play around and try additional cases out by hand to understand the boundaries of the tool. In this guide then, we should simply reference the different options to be tried out in katacoda.
Totally agree with you that we should give clear guidance for decision on which extension/plugin to choose. I will do some rework on it. The hint with the tutorials is also a good one. This should be easy ones. I created an issue for that https://github.com/devonfw-tutorials/tutorials/issues/179
PR for https://github.com/devonfw/devon4j/issues/483 Added a guide to OpenAPI describing what OpenAPI is and extensions/plugins to automatically create OpenAPI specifications from REST APIs. For the Maven plugin ServicedocGen, I've linked to the Quarkus reference application as we plan to modify the project to use the plugin in the future.