Skip to content

add support for sealed response interfaces for spring-declarative-http-interface #23549

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

Open
tempacc21 wants to merge 1 commit into
base: master
Choose a base branch
from
+44 −8
Open

add support for sealed response interfaces for spring-declarative-http-interface #23549

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
16 changes: 8 additions & 8 deletions ...tlin-spring/libraries/spring-declarative-http-interface/httpInterfaceReturnTypes.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
{{! handle reactive map and array}}
{{#reactive}}
{{#isMap}}
{{#reactiveModeReactor}}Mono<{{/reactiveModeReactor}}{{#useResponseEntity}}ResponseEntity<{{/useResponseEntity}}Map<String, {{{returnType}}}>{{#useResponseEntity}}>{{/useResponseEntity}}{{#reactiveModeReactor}}>{{/reactiveModeReactor}}
{{#reactiveModeReactor}}Mono<{{/reactiveModeReactor}}{{#useResponseEntity}}ResponseEntity<{{/useResponseEntity}}Map<String, {{#useSealedResponseInterfaces}}{{#vendorExtensions.x-sealed-response-interface}}{{vendorExtensions.x-sealed-response-interface}}{{/vendorExtensions.x-sealed-response-interface}}{{^vendorExtensions.x-sealed-response-interface}}{{{returnType}}}{{/vendorExtensions.x-sealed-response-interface}}{{/useSealedResponseInterfaces}}{{^useSealedResponseInterfaces}}{{{returnType}}}{{/useSealedResponseInterfaces}}>{{#useResponseEntity}}>{{/useResponseEntity}}{{#reactiveModeReactor}}>{{/reactiveModeReactor}}
{{/isMap}}
{{#isArray}}
{{! array handle reactive - reactor with/without ResponseEntity wrapper}}
{{#reactiveModeReactor}}
{{#useResponseEntity}}Mono<ResponseEntity<{{/useResponseEntity}}Flux<{{{returnType}}}>{{#useResponseEntity}}>>{{/useResponseEntity}}
{{#useResponseEntity}}Mono<ResponseEntity<{{/useResponseEntity}}Flux<{{#useSealedResponseInterfaces}}{{#vendorExtensions.x-sealed-response-interface}}{{vendorExtensions.x-sealed-response-interface}}{{/vendorExtensions.x-sealed-response-interface}}{{^vendorExtensions.x-sealed-response-interface}}{{{returnType}}}{{/vendorExtensions.x-sealed-response-interface}}{{/useSealedResponseInterfaces}}{{^useSealedResponseInterfaces}}{{{returnType}}}{{/useSealedResponseInterfaces}}>{{#useResponseEntity}}>>{{/useResponseEntity}}
{{/reactiveModeReactor}}
{{! array handle reactive - coroutines with/without ResponseEntity wrapper}}
{{#reactiveModeCoroutines}}
{{#useResponseEntity}}ResponseEntity<{{/useResponseEntity}}{{{returnContainer}}}<{{{returnType}}}>{{#useResponseEntity}}>{{/useResponseEntity}}
{{#useResponseEntity}}ResponseEntity<{{/useResponseEntity}}{{{returnContainer}}}<{{#useSealedResponseInterfaces}}{{#vendorExtensions.x-sealed-response-interface}}{{vendorExtensions.x-sealed-response-interface}}{{/vendorExtensions.x-sealed-response-interface}}{{^vendorExtensions.x-sealed-response-interface}}{{{returnType}}}{{/vendorExtensions.x-sealed-response-interface}}{{/useSealedResponseInterfaces}}{{^useSealedResponseInterfaces}}{{{returnType}}}{{/useSealedResponseInterfaces}}>{{#useResponseEntity}}>{{/useResponseEntity}}
{{/reactiveModeCoroutines}}
{{/isArray}}
{{! handle reactive non-container - with/without ResponseEntity wrapper}}
{{^returnContainer}}
{{#reactiveModeReactor}}
Mono<{{#useResponseEntity}}ResponseEntity<{{/useResponseEntity}}{{{returnType}}}{{#useResponseEntity}}>{{/useResponseEntity}}>
Mono<{{#useResponseEntity}}ResponseEntity<{{/useResponseEntity}}{{#useSealedResponseInterfaces}}{{#vendorExtensions.x-sealed-response-interface}}{{vendorExtensions.x-sealed-response-interface}}{{/vendorExtensions.x-sealed-response-interface}}{{^vendorExtensions.x-sealed-response-interface}}{{{returnType}}}{{/vendorExtensions.x-sealed-response-interface}}{{/useSealedResponseInterfaces}}{{^useSealedResponseInterfaces}}{{{returnType}}}{{/useSealedResponseInterfaces}}{{#useResponseEntity}}>{{/useResponseEntity}}>
{{/reactiveModeReactor}}
{{#reactiveModeCoroutines}}
{{#useResponseEntity}}
ResponseEntity<{{/useResponseEntity}}{{{returnType}}}{{#useResponseEntity}}>
ResponseEntity<{{/useResponseEntity}}{{#useSealedResponseInterfaces}}{{#vendorExtensions.x-sealed-response-interface}}{{vendorExtensions.x-sealed-response-interface}}{{/vendorExtensions.x-sealed-response-interface}}{{^vendorExtensions.x-sealed-response-interface}}{{{returnType}}}{{/vendorExtensions.x-sealed-response-interface}}{{/useSealedResponseInterfaces}}{{^useSealedResponseInterfaces}}{{{returnType}}}{{/useSealedResponseInterfaces}}{{#useResponseEntity}}>
{{/useResponseEntity}}
{{/reactiveModeCoroutines}}
{{/returnContainer}}
Expand All @@ -29,19 +29,19 @@ ResponseEntity<{{/useResponseEntity}}{{{returnType}}}{{#useResponseEntity}}>
{{! handle non-reactive map and array}}
{{#isMap}}
{{#useResponseEntity}}
ResponseEntity<{{/useResponseEntity}}Map<String, {{{returnType}}}>{{#useResponseEntity}}>
ResponseEntity<{{/useResponseEntity}}Map<String, {{#useSealedResponseInterfaces}}{{#vendorExtensions.x-sealed-response-interface}}{{vendorExtensions.x-sealed-response-interface}}{{/vendorExtensions.x-sealed-response-interface}}{{^vendorExtensions.x-sealed-response-interface}}{{{returnType}}}{{/vendorExtensions.x-sealed-response-interface}}{{/useSealedResponseInterfaces}}{{^useSealedResponseInterfaces}}{{{returnType}}}{{/useSealedResponseInterfaces}}>{{#useResponseEntity}}>
{{/useResponseEntity}}
{{/isMap}}
{{#isArray}}
{{! array handle non-reactive - with/without ResponseEntity wrapper}}
{{#useResponseEntity}}
ResponseEntity<{{/useResponseEntity}}{{{returnContainer}}}<{{{returnType}}}>{{#useResponseEntity}}>
ResponseEntity<{{/useResponseEntity}}{{{returnContainer}}}<{{#useSealedResponseInterfaces}}{{#vendorExtensions.x-sealed-response-interface}}{{vendorExtensions.x-sealed-response-interface}}{{/vendorExtensions.x-sealed-response-interface}}{{^vendorExtensions.x-sealed-response-interface}}{{{returnType}}}{{/vendorExtensions.x-sealed-response-interface}}{{/useSealedResponseInterfaces}}{{^useSealedResponseInterfaces}}{{{returnType}}}{{/useSealedResponseInterfaces}}>{{#useResponseEntity}}>
{{/useResponseEntity}}
{{/isArray}}
{{! handle reactive non-container - with/without ResponseEntity wrapper}}
{{^returnContainer}}
{{#useResponseEntity}}
ResponseEntity<{{/useResponseEntity}}{{{returnType}}}{{#useResponseEntity}}>
ResponseEntity<{{/useResponseEntity}}{{#useSealedResponseInterfaces}}{{#vendorExtensions.x-sealed-response-interface}}{{vendorExtensions.x-sealed-response-interface}}{{/vendorExtensions.x-sealed-response-interface}}{{^vendorExtensions.x-sealed-response-interface}}{{{returnType}}}{{/vendorExtensions.x-sealed-response-interface}}{{/useSealedResponseInterfaces}}{{^useSealedResponseInterfaces}}{{{returnType}}}{{/useSealedResponseInterfaces}}{{#useResponseEntity}}>
{{/useResponseEntity}}
{{/returnContainer}}
{{/reactive}}
36 changes: 36 additions & 0 deletions ...r/src/test/java/org/openapitools/codegen/kotlin/spring/KotlinSpringServerCodegenTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5054,4 +5054,40 @@ public void shouldAddParameterWithInHeaderWhenImplicitHeadersIsTrue() throws IOE
Assert.assertTrue(content.contains("testHeader"),
"Header name 'testHeader' should appear in the annotation");
}

@Test
public void testSealedResponseInterfacesWithDeclarativeHttpInterface() throws IOException {
File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
output.deleteOnExit();
String outputPath = output.getAbsolutePath().replace('\\', '/');

OpenAPI openAPI = new OpenAPIParser()
.readLocation("src/test/resources/3_0/kotlin/sealed-response-interfaces.yaml", null, new ParseOptions()).getOpenAPI();

KotlinSpringServerCodegen codegen = new KotlinSpringServerCodegen();
codegen.setOutputDir(output.getAbsolutePath());
codegen.additionalProperties().put(CodegenConstants.MODEL_PACKAGE, "org.openapitools.model");
codegen.additionalProperties().put(CodegenConstants.API_PACKAGE, "org.openapitools.api");
codegen.additionalProperties().put(CodegenConstants.LIBRARY, "spring-declarative-http-interface");
codegen.additionalProperties().put(USE_SEALED_RESPONSE_INTERFACES, "true");
codegen.additionalProperties().put(USE_RESPONSE_ENTITY, "true");
codegen.additionalProperties().put(REACTIVE, "false");
codegen.additionalProperties().put(USE_FLOW_FOR_ARRAY_RETURN_TYPE, "false");

ClientOptInput input = new ClientOptInput();
input.openAPI(openAPI);
input.config(codegen);

DefaultGenerator generator = new DefaultGenerator();
generator.opts(input).generate();

assertFileContains(Paths.get(outputPath + "/src/main/kotlin/org/openapitools/api/DefaultApi.kt"),
"import org.openapitools.model.CreateUserResponse",
"import org.openapitools.model.GetUserResponse",
"fun createUser(",
"): ResponseEntity<CreateUserResponse>",
"fun getUser(",
"): ResponseEntity<GetUserResponse>");
}

}
Loading