Skip to content

[Java][Spring] Insert Annotations to be TYPE_USE Compatible #23207

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Chrimle wants to merge 1 commit into from
Closed

[Java][Spring] Insert Annotations to be TYPE_USE Compatible #23207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions ...enapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import org.apache.commons.lang3.StringUtils;
import org.assertj.core.api.Assertions;
import org.assertj.core.api.MapAssert;
import org.junit.jupiter.api.DisplayName;
import org.openapitools.codegen.*;
import org.openapitools.codegen.config.CodegenConfigurator;
import org.openapitools.codegen.config.GlobalSettings;
Expand Down Expand Up @@ -6637,4 +6638,33 @@ public void shouldNotHaveDocumentationAnnotationWhenUsingLibrarySpringHttpInterf
JavaFileAssert.assertThat(Paths.get(outputPath + "/src/main/java/org/openapitools/api/PetApi.java"))
.assertMethod("addPet").assertParameter("pet").assertParameterAnnotations().doesNotContainWithName("Parameter");
}

@Test
@DisplayName("Testing Issue #23206: Support JSpecify with SchemaMappings")
public void testIssue23206() throws IOException {
final SpringCodegen codegen = new SpringCodegen();

codegen.setLibrary("spring-boot");

codegen.importMapping().put("org.springframework.lang.Nullable", "org.jspecify.annotations.Nullable");
codegen.schemaMapping().put("PersonCountValue", "a.b.c.PersonCountValue");

codegen.additionalProperties().put(OPENAPI_NULLABLE, "false");
codegen.additionalProperties().put(SKIP_DEFAULT_INTERFACE, "true");
codegen.additionalProperties().put(USE_SPRING_BOOT4, "true");
codegen.additionalProperties().put(USE_JACKSON_3, "true");
codegen.additionalProperties().put(USE_TAGS, "true");
codegen.additionalProperties().put(USE_BEANVALIDATION, "false");

final Map<String, File> files = generateFiles(codegen, "src/test/resources/3_0/spring/issue_23206.yaml");
final var javaFileAssert = JavaFileAssert.assertThat(files.get("MyDto.java"));

javaFileAssert
.hasImports("org.jspecify.annotations.Nullable")
.assertProperty("men");

// Should Fail without any changes to the mustache templates!
javaFileAssert.fileContains("private a.b.c.@Nullable PersonCountValue men;"); // Actual: private @Nullable a.b.c.PersonCountValue men;
javaFileAssert.fileContains("private a.b.c.@Nullable PersonCountValue women;"); // Actual: private @Nullable a.b.c.PersonCountValue women;
}
}
28 changes: 28 additions & 0 deletions modules/openapi-generator/src/test/resources/3_0/spring/issue_23206.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
openapi: "3.0.3"
info:
title: Move Annotations in Generated POJOs
description: "Test Placement of Annotations, to allow TYPE_USE Annotations to compile correctly. See #23206"
version: 1.0.0

paths:
/some/endpoint:
get:
responses:
"200":
description: OK

components:
schemas:
MyDto:
type: object
properties:
men:
nullable: true
$ref: '#/components/schemas/PersonCountValue'
women:
nullable: true
$ref: '#/components/schemas/PersonCountValue'
PersonCountValue:
type: number
format: personCountValue
example: 1234
Loading