OpenAPITools / OpenAPITools/openapi-generator
[REQ] Feature Request Description
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Is there a way to disable the generation of Swagger documentation annotations in Java code? OpenAPI generates documentation with Swagger UI from the OpenAPI YAML specification - not from the Swagger annotations. This requires Swagger as a compile time dependency, essentially for a feature we won't be using.
I saw the following issue: #5058
This issue was for adding a 'useDocumentationAnnotations' option for Java Spring. This looked like what was desired. I added a comment asking about this. Specifically, I am looking for this feature for Springboot WebFlux reactive. I asked this question 5 days ago, and within the last 4 hours the issue was closed.
I'm currently using the 5.0.0-beta2 release.
Is there a timetable for when a configuration option to disable generation of the Swagger annotations will be available?
Thank you.
-Mark
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Spring Boot WebFlux generator and compare its annotation generation with the existing useDocumentationAnnotations work in PR #5058. Determine how a configuration option would disable Swagger annotations while preserving generation from the OpenAPI specification. Done means the option works for WebFlux output and generated Java code is covered by tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring-boot
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100