OpenAPITools / OpenAPITools/openapi-generator

[REQ] [SPRING] add a config to exclude swagger import

Open
#7,902 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Is your feature request related to a problem? Please describe.

Hi everyone, i noticed that you can't generate a spring code without all the swagger annotation and import io.swagger.annotations.*; i would love to have an option to opt out all the unnecessary annotations and import from the generated code.

Describe the solution you'd like

I would have the same configuration useSwaggerAnnotations used in jax-rs generator in the spring generator,

Describe alternatives you've considered

I didn't think to any alternative, the configuration defaulted to the standard behavior could be the right choice

I could work on it if this proposal will be accepted!

Thanks
Cristian

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the linked jax-rs configuration documentation for useSwaggerAnnotations with the Spring generator's configuration and templates. Verify generated Spring code with the option enabled and disabled, and consider the work done when the disabled output contains neither Swagger annotations nor the io.swagger.annotations import while the default behavior remains unchanged.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi, spring
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.