OpenAPITools / OpenAPITools/openapi-generator
[BUG][spring] openapi.NAME.base-path not used in swagger home controller
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?
- Have you validated the input using an OpenAPI validator (example)?
- What's the version of OpenAPI Generator used?
- Have you search for related issues/PRs?
- What's the actual output vs expected output?
Description
HomeController for swagger has hardcoded @RequestMapping("/"). It should use a variable here like all other generated controllers do.
openapi-generator version
4.2.3
Suggest a fix
Change the template of swagger to use the same variable for the base path as all other generated controllers do (simple fix)
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 by locating the Spring generator template for the Swagger HomeController and compare its base-path handling with the other generated controllers. Update the template so the home mapping uses the generated base-path variable, then generate a Spring server from a minimal OpenAPI spec and verify the Swagger home endpoint is mounted under that path.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring
- Domain
- api, backend
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100