OpenAPITools / OpenAPITools/openapi-generator

[BUG] [JAVA] Client names not generated from spec

Open
#19,848 0 comments 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

When generating API clients, the name field is no longer injected from tags. resulting in the API name being the placeholder value.

openapi-generator version

v7.9.0

OpenAPI declaration file content or url
openapi: 3.0.1
info:
  title: test-microservice
servers:
  - url: https://testms.org/
tags:
  - name: test-ms-controller
    description: Test MS Controller
paths:
  /api/v1/test:
    get: ...
Generation Details

Generated via openapi-swagger-maven-plugin, using Spring generator with Spring Cloud library. Spring Boot 3 enabled.

Steps to reproduce

Generate any API Client with the described setup. Within the spec, set the tags.name field to the desired API client name. In the generated client code the FeignClient annotation name field should be set to the tag.name value. However, now just holds the default API value. Rolling back to any v6.X.X will produce the desired outcome.

Current output:
@FeignClient(name="${api.name:api}", url="${api.url:https://testms.org}", configuration = ClientConfiguration.class)
Expected output:
@FeignClient(name="${testMsController.name:testMsController}", url="${api.url:https://ms-eg-prospect-transform-q.apps.pcfnp.fnni.com}", configuration = ClientConfiguration.class)

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 reproducing the issue with the supplied OpenAPI YAML through the openapi-swagger-maven-plugin using the Spring generator and Spring Cloud library. Compare v7.9.0 with a v6.x release and trace how the tags.name value reaches the generated @FeignClient annotation. Done means the generated name uses the tag-derived value instead of the default api value.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi, spring
Domain
api, backend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 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.