fix(java-spring): use lambdaEscapeDoubleQuote in api.mustache
Merged
KA
4mo ago+82+82+01234567890123456789-4-4-0123456789
Fixes #22629
This PR fixes a bug in the Java/Spring generator where tag names and operation tags containing double quotes (e.g., My "quoted" api) were not correctly escaped. This previously caused Java syntax/compilation errors in the generated @Tag annotation and generated invalid HTML entities (") inside the @Operation tags array.
Changes
- Templates: Updated class-level annotations (
@Tag(name = ...)and@Api(value = ...)) and method-level annotations (@Operation(tags = ...)and@ApiOperation(tags = ...)) inJavaSpring/api.mustacheto wraptagNameandtaginside thelambdaEscapeDoubleQuotemustache lambda. - Test Fixture: Added a minimal OpenAPI reproduction spec at
modules/openapi-generator/src/test/resources/3_0/issue_22629.yaml. - Unit Test: Added the corresponding unit test case
testStringQuotesInTags_Issue22629()inSpringCodegenTest.javato verify correct escaping.
PR checklist
- Read the contribution guidelines.
- Run the following to build the project and update samples:
(For Windows users, please run the script in WSL)./mvnw clean package || exit ./bin/generate-samples.sh ./bin/configs/*.yaml || exit ./bin/utils/export_docs_generators.sh || exit
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example./bin/generate-samples.sh bin/configs/java*.
IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed. - If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
Summary by cubic
Escapes quotes, backslashes, and newlines in Java/Spring tag names and tags to prevent compilation errors and HTML-escaped quotes in generated annotations. Fixes #22629.
- Bug Fixes
- Escape
tagNameandtaginSpringCodegenviaescapeText. - Render
tagwith{{{tag}}}inJavaSpring/api.mustachefor@Operationand@ApiOperationto avoid HTML-entity encoding; revert thelambdaEscapeDoubleQuoteapproach. - Add
issue_22629.yamlandtestStringQuotesInTags_Issue22629to verify escaping in@Tag(name = ...)and@Operation(tags = ...).
- Escape