OpenAPITools / OpenAPITools/openapi-generator

[BUG][JAVA][SPRING] HomeController template ignored

Open
#12,905 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
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)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

It seems that JavaSpring's template for HomeController.java (homeController.mustache) is completely ignored:

  • The class' comment is "Home redirection to OpenAPI api documentation" in the template but is "Home redirection to swagger api documentation" in the generated code
  • Using the option <documentationProvider>source</documentationProvider> with the maven plugin does nothing
  • Using a custom template with the maven plugin (declared in dependencies) changes nothing
openapi-generator version

6.0.0

OpenAPI declaration file content or url

Irrelevant

Generation Details

Any generation with supporting files should show the comment difference.

I'm using the maven plugin with configuration <supportingFilesToGenerate>ApiUtil.java,HomeController.java,openapi.yaml</supportingFilesToGenerate>.

Steps to reproduce

Any generation with supporting files should show the comment difference.

Related issues/PRs

None found

Suggest a fix

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 with modules/openapi-generator/src/main/resources/JavaSpring/homeController.mustache and the JavaSpring supporting-file generation path. Reproduce the Maven plugin configuration using supportingFilesToGenerate, then compare the generated HomeController.java with the template and test custom-template and documentationProvider behavior. Done means the intended template and options affect the generated supporting file.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.