OpenAPITools / OpenAPITools/openapi-generator
[BUG][SPRING] SpringFox Docket generated in OpenAPIDocumentationConfig is not setup for authentication
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Bug Report Checklist
- Have you provided a full/minimal spec to reproduce the issue? Tried with AuthenticationCode
- Have you validated the input using an OpenAPI validator (example)? no
- What's the version of OpenAPI Generator used? 4.3.1
- Have you search for related issues/PRs? yes
- What's the actual output vs expected output?
I was expecting that the Docket would be generated with the securitySchemes and securityContext to allow using authentication on the swagger-ui based on the openapi contract.
I would suggest to add the security parameters in the template https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/resources/JavaSpring/openapiDocumentationConfig.mustache
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 modules/openapi-generator/src/main/resources/JavaSpring/openapiDocumentationConfig.mustache and inspect how the generated SpringFox Docket is configured. Compare the generated configuration with the OpenAPI contract's authentication requirements; done means the generated securitySchemes and securityContext allow authentication through swagger-ui.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, openapi, spring
- Domain
- api, backend, security
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100