Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Issues
  • #12220
Closed
Open
Issue created Apr 23, 2022 by Administrator@rootContributor

[REQ][JAVA][SPRING] Adding springdoc-openapi support for service metadata and security

Created by: bluenick2k17

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

I am configuring my auto generated API code, and I am concerned because although spring fox won't be supported in the future, springdoc doesn't currently get supplied all of the information that it should be. Without me creating an additional configuration file, the swagger page provided by springdoc just called my API "OpenAPI Definition" and doesn't provide the additional metadata that OpenAPI offers from the yaml file like the rest of the info section, servers, or Security Schemes. Security schemes being set up on this level also enables the authorization features in the swagger UI, which would be a huge functional plus.

Describe the solution you'd like

I would like there to be an additional configuration class created to handle the Open API definitions at least from the following listed annotations, to provide support for some of the swagger UI features that can't currently be used

  • OpenAPIDefinition
  • SecurityScheme and/or SecuritySchemes

I figure this would just be an additional class generated (e.g. SpringDocsUIConfiguration), which configures the annotations mentioned above and the @Configuration annotation, so that the docs site can pick up the new details.

Describe alternatives you've considered

  • The main alternative is being forced to add my own configuration file and supply all of this data myself, However, I would much rather have the documentation website directly linked to the swagger file.

Additional context

Assignee
Assign to
Time tracking