OpenAPITools / OpenAPITools/openapi-generator

[BUG][SPRING] Example string generation does not compile when using "$ref"

Open
#9,976 2 comments 3 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 "spring" code for an endpoint that returns an array and the object definition is a "$ref" and the object definition has an example, the generated code contains a string that doesn't compile. The backslashes of the example are wrongly escaped.

openapi-generator version

5.2.0

OpenAPI declaration file content or url

https://gist.github.com/benfonty/98c445d969b84896019d6c09bcb25ccd

Generation Details

openapi-generator generate -i test-api.json -g spring -o ./generated

Steps to reproduce

openapi-generator generate -i test-api.json -g spring -o ./generated

Try to build the generated code.

There is an error in ./generated/src/main/java/org/openapitools/api/TestApi.java.

String exampleString = "{ \"adminUser\" : \"{\\"userName\\":\\"admin.user@example.com\\"}\", \"id\" : \"id\" }";

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 running the shown openapi-generator command with the linked test-api.json specification and inspect ./generated/src/main/java/org/openapitools/api/TestApi.java. Trace the Spring generator path that produces exampleString; done means the generated Java builds successfully without the escaping error and the "$ref" array case remains covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi, spring
Domain
api, 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.