Skip to content

[Java][Spring] Use better return types for the reactive option #913

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

Merged
wing328 merged 1 commit into from
Sep 2, 2018
Merged

[Java][Spring] Use better return types for the reactive option #913

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
3 changes: 3 additions & 0 deletions ...les/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,6 +354,9 @@ public void processOpts() {
if (this.async) {
additionalProperties.put(RESPONSE_WRAPPER, "CompletableFuture");
}
if (this.reactive) {
additionalProperties.put(RESPONSE_WRAPPER, "Mono");
}
} else if (this.async) {
additionalProperties.put(RESPONSE_WRAPPER, "Callable");
}
Expand Down
8 changes: 4 additions & 4 deletions modules/openapi-generator/src/main/resources/JavaSpring/methodBody.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,19 +29,19 @@ return {{#jdk8}}{{#async}}CompletableFuture.completedFuture({{/async}}{{/jdk8}}n
{{/examples}}
{{/reactive}}
{{#reactive}}
{{>returnTypes}} result = {{#isListContainer}}Flux{{/isListContainer}}{{^isListContainer}}Mono{{/isListContainer}}.empty();
exchange.getResponse().setStatusCode(HttpStatus.NOT_IMPLEMENTED);
Mono<Void> result = Mono.empty();
{{#examples}}
{{#-first}}
for (MediaType mediaType : exchange.getRequest().getHeaders().getAccept()) {
{{/-first}}
if (mediaType.isCompatibleWith(MediaType.valueOf("{{{contentType}}}"))) {
result = ApiUtil.getExampleResponse(exchange, "{{#lambdaRemoveLineBreak}}{{#lambdaEscapeDoubleQuote}}{{{example}}}{{/lambdaEscapeDoubleQuote}}{{/lambdaRemoveLineBreak}}")
.then{{#isListContainer}}Many{{/isListContainer}}(Mono.empty());
result = ApiUtil.getExampleResponse(exchange, "{{#lambdaRemoveLineBreak}}{{#lambdaEscapeDoubleQuote}}{{{example}}}{{/lambdaEscapeDoubleQuote}}{{/lambdaRemoveLineBreak}}");
break;
}
{{#-last}}
}
{{/-last}}
{{/examples}}
return ResponseEntity.status(HttpStatus.NOT_IMPLEMENTED).body({{^isListContainer}}{{#allParams}}{{#isBodyParam}}{{paramName}}.then({{/isBodyParam}}{{/allParams}}{{/isListContainer}}{{#isListContainer}}{{#allParams}}{{#isBodyParam}}{{paramName}}.thenMany({{/isBodyParam}}{{/allParams}}{{/isListContainer}}result{{#allParams}}{{#isBodyParam}}){{/isBodyParam}}{{/allParams}});
return result.then(Mono.empty());
{{/reactive}}
2 changes: 1 addition & 1 deletion modules/openapi-generator/src/main/resources/JavaSpring/returnTypes.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{{#isMapContainer}}{{#reactive}}Mono<{{/reactive}}Map<String, {{{returnType}}}{{#reactive}}>{{/reactive}}>{{/isMapContainer}}{{#isListContainer}}{{#reactive}}Flux{{/reactive}}{{^reactive}}List{{/reactive}}<{{{returnType}}}>{{/isListContainer}}{{^returnContainer}}{{#reactive}}Mono<{{{returnType}}}>{{/reactive}}{{^reactive}}{{{returnType}}}{{/reactive}}{{/returnContainer}}
{{#isMapContainer}}Map<String, {{{returnType}}}>{{/isMapContainer}}{{#isListContainer}}{{#reactive}}Flux{{/reactive}}{{^reactive}}List{{/reactive}}<{{{returnType}}}>{{/isListContainer}}{{^returnContainer}}{{{returnType}}}{{/returnContainer}}
10 changes: 5 additions & 5 deletions ...erver/petstore/springboot-reactive/src/main/java/org/openapitools/api/AnotherFakeApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,16 +40,16 @@ public interface AnotherFakeApi {
produces = { "application/json" },
consumes = { "application/json" },
method = RequestMethod.PATCH)
default ResponseEntity<Mono<Client>> call123testSpecialTags(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Mono<Client> client, ServerWebExchange exchange) {
Mono<Client> result = Mono.empty();
default Mono<ResponseEntity<Client>> call123testSpecialTags(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Mono<Client> client, ServerWebExchange exchange) {
exchange.getResponse().setStatusCode(HttpStatus.NOT_IMPLEMENTED);
Mono<Void> result = Mono.empty();
for (MediaType mediaType : exchange.getRequest().getHeaders().getAccept()) {
if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) {
result = ApiUtil.getExampleResponse(exchange, "{ \"client\" : \"client\"}")
.then(Mono.empty());
result = ApiUtil.getExampleResponse(exchange, "{ \"client\" : \"client\"}");
break;
}
}
return ResponseEntity.status(HttpStatus.NOT_IMPLEMENTED).body(client.then(result));
return result.then(Mono.empty());

}

Expand Down
90 changes: 48 additions & 42 deletions samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/FakeApi.java
View file
Open in desktop

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions ...petstore/springboot-reactive/src/main/java/org/openapitools/api/FakeClassnameTestApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,16 @@ public interface FakeClassnameTestApi {
produces = { "application/json" },
consumes = { "application/json" },
method = RequestMethod.PATCH)
default ResponseEntity<Mono<Client>> testClassname(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Mono<Client> client, ServerWebExchange exchange) {
Mono<Client> result = Mono.empty();
default Mono<ResponseEntity<Client>> testClassname(@ApiParam(value = "client model" ,required=true ) @Valid @RequestBody Mono<Client> client, ServerWebExchange exchange) {
exchange.getResponse().setStatusCode(HttpStatus.NOT_IMPLEMENTED);
Mono<Void> result = Mono.empty();
for (MediaType mediaType : exchange.getRequest().getHeaders().getAccept()) {
if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) {
result = ApiUtil.getExampleResponse(exchange, "{ \"client\" : \"client\"}")
.then(Mono.empty());
result = ApiUtil.getExampleResponse(exchange, "{ \"client\" : \"client\"}");
break;
}
}
return ResponseEntity.status(HttpStatus.NOT_IMPLEMENTED).body(client.then(result));
return result.then(Mono.empty());

}

Expand Down
69 changes: 35 additions & 34 deletions samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/PetApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,10 @@ public interface PetApi {
@RequestMapping(value = "/pet",
consumes = { "application/json", "application/xml" },
method = RequestMethod.POST)
default ResponseEntity<Mono<Void>> addPet(@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Mono<Pet> pet, ServerWebExchange exchange) {
default Mono<ResponseEntity<Void>> addPet(@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Mono<Pet> pet, ServerWebExchange exchange) {
exchange.getResponse().setStatusCode(HttpStatus.NOT_IMPLEMENTED);
Mono<Void> result = Mono.empty();
return ResponseEntity.status(HttpStatus.NOT_IMPLEMENTED).body(pet.then(result));
return result.then(Mono.empty());

}

Expand All @@ -63,9 +64,10 @@ default ResponseEntity<Mono<Void>> addPet(@ApiParam(value = "Pet object that nee
@ApiResponse(code = 400, message = "Invalid pet value") })
@RequestMapping(value = "/pet/{petId}",
method = RequestMethod.DELETE)
default ResponseEntity<Mono<Void>> deletePet(@ApiParam(value = "Pet id to delete",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "" ) @RequestHeader(value="api_key", required=false) String apiKey, ServerWebExchange exchange) {
default Mono<ResponseEntity<Void>> deletePet(@ApiParam(value = "Pet id to delete",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "" ) @RequestHeader(value="api_key", required=false) String apiKey, ServerWebExchange exchange) {
exchange.getResponse().setStatusCode(HttpStatus.NOT_IMPLEMENTED);
Mono<Void> result = Mono.empty();
return ResponseEntity.status(HttpStatus.NOT_IMPLEMENTED).body(result);
return result.then(Mono.empty());

}

Expand All @@ -82,21 +84,20 @@ default ResponseEntity<Mono<Void>> deletePet(@ApiParam(value = "Pet id to delete
@RequestMapping(value = "/pet/findByStatus",
produces = { "application/xml", "application/json" },
method = RequestMethod.GET)
default ResponseEntity<Flux<Pet>> findPetsByStatus(@NotNull @ApiParam(value = "Status values that need to be considered for filter", required = true, allowableValues = "available, pending, sold") @Valid @RequestParam(value = "status", required = true) List<String> status, ServerWebExchange exchange) {
Flux<Pet> result = Flux.empty();
default Mono<ResponseEntity<Flux<Pet>>> findPetsByStatus(@NotNull @ApiParam(value = "Status values that need to be considered for filter", required = true, allowableValues = "available, pending, sold") @Valid @RequestParam(value = "status", required = true) List<String> status, ServerWebExchange exchange) {
exchange.getResponse().setStatusCode(HttpStatus.NOT_IMPLEMENTED);
Mono<Void> result = Mono.empty();
for (MediaType mediaType : exchange.getRequest().getHeaders().getAccept()) {
if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) {
result = ApiUtil.getExampleResponse(exchange, "{ \"photoUrls\" : [ \"photoUrls\", \"photoUrls\" ], \"name\" : \"doggie\", \"id\" : 0, \"category\" : { \"name\" : \"name\", \"id\" : 6 }, \"tags\" : [ { \"name\" : \"name\", \"id\" : 1 }, { \"name\" : \"name\", \"id\" : 1 } ], \"status\" : \"available\"}")
.thenMany(Mono.empty());
result = ApiUtil.getExampleResponse(exchange, "{ \"photoUrls\" : [ \"photoUrls\", \"photoUrls\" ], \"name\" : \"doggie\", \"id\" : 0, \"category\" : { \"name\" : \"name\", \"id\" : 6 }, \"tags\" : [ { \"name\" : \"name\", \"id\" : 1 }, { \"name\" : \"name\", \"id\" : 1 } ], \"status\" : \"available\"}");
break;
}
if (mediaType.isCompatibleWith(MediaType.valueOf("application/xml"))) {
result = ApiUtil.getExampleResponse(exchange, "<Pet> <id>123456789</id> <name>doggie</name> <photoUrls> <photoUrls>aeiou</photoUrls> </photoUrls> <tags> </tags> <status>aeiou</status></Pet>")
.thenMany(Mono.empty());
result = ApiUtil.getExampleResponse(exchange, "<Pet> <id>123456789</id> <name>doggie</name> <photoUrls> <photoUrls>aeiou</photoUrls> </photoUrls> <tags> </tags> <status>aeiou</status></Pet>");
break;
}
}
return ResponseEntity.status(HttpStatus.NOT_IMPLEMENTED).body(result);
return result.then(Mono.empty());

}

Expand All @@ -113,21 +114,20 @@ default ResponseEntity<Flux<Pet>> findPetsByStatus(@NotNull @ApiParam(value = "S
@RequestMapping(value = "/pet/findByTags",
produces = { "application/xml", "application/json" },
method = RequestMethod.GET)
default ResponseEntity<Flux<Pet>> findPetsByTags(@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) List<String> tags, ServerWebExchange exchange) {
Flux<Pet> result = Flux.empty();
default Mono<ResponseEntity<Flux<Pet>>> findPetsByTags(@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) List<String> tags, ServerWebExchange exchange) {
exchange.getResponse().setStatusCode(HttpStatus.NOT_IMPLEMENTED);
Mono<Void> result = Mono.empty();
for (MediaType mediaType : exchange.getRequest().getHeaders().getAccept()) {
if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) {
result = ApiUtil.getExampleResponse(exchange, "{ \"photoUrls\" : [ \"photoUrls\", \"photoUrls\" ], \"name\" : \"doggie\", \"id\" : 0, \"category\" : { \"name\" : \"name\", \"id\" : 6 }, \"tags\" : [ { \"name\" : \"name\", \"id\" : 1 }, { \"name\" : \"name\", \"id\" : 1 } ], \"status\" : \"available\"}")
.thenMany(Mono.empty());
result = ApiUtil.getExampleResponse(exchange, "{ \"photoUrls\" : [ \"photoUrls\", \"photoUrls\" ], \"name\" : \"doggie\", \"id\" : 0, \"category\" : { \"name\" : \"name\", \"id\" : 6 }, \"tags\" : [ { \"name\" : \"name\", \"id\" : 1 }, { \"name\" : \"name\", \"id\" : 1 } ], \"status\" : \"available\"}");
break;
}
if (mediaType.isCompatibleWith(MediaType.valueOf("application/xml"))) {
result = ApiUtil.getExampleResponse(exchange, "<Pet> <id>123456789</id> <name>doggie</name> <photoUrls> <photoUrls>aeiou</photoUrls> </photoUrls> <tags> </tags> <status>aeiou</status></Pet>")
.thenMany(Mono.empty());
result = ApiUtil.getExampleResponse(exchange, "<Pet> <id>123456789</id> <name>doggie</name> <photoUrls> <photoUrls>aeiou</photoUrls> </photoUrls> <tags> </tags> <status>aeiou</status></Pet>");
break;
}
}
return ResponseEntity.status(HttpStatus.NOT_IMPLEMENTED).body(result);
return result.then(Mono.empty());

}

Expand All @@ -142,21 +142,20 @@ default ResponseEntity<Flux<Pet>> findPetsByTags(@NotNull @ApiParam(value = "Tag
@RequestMapping(value = "/pet/{petId}",
produces = { "application/xml", "application/json" },
method = RequestMethod.GET)
default ResponseEntity<Mono<Pet>> getPetById(@ApiParam(value = "ID of pet to return",required=true) @PathVariable("petId") Long petId, ServerWebExchange exchange) {
Mono<Pet> result = Mono.empty();
default Mono<ResponseEntity<Pet>> getPetById(@ApiParam(value = "ID of pet to return",required=true) @PathVariable("petId") Long petId, ServerWebExchange exchange) {
exchange.getResponse().setStatusCode(HttpStatus.NOT_IMPLEMENTED);
Mono<Void> result = Mono.empty();
for (MediaType mediaType : exchange.getRequest().getHeaders().getAccept()) {
if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) {
result = ApiUtil.getExampleResponse(exchange, "{ \"photoUrls\" : [ \"photoUrls\", \"photoUrls\" ], \"name\" : \"doggie\", \"id\" : 0, \"category\" : { \"name\" : \"name\", \"id\" : 6 }, \"tags\" : [ { \"name\" : \"name\", \"id\" : 1 }, { \"name\" : \"name\", \"id\" : 1 } ], \"status\" : \"available\"}")
.then(Mono.empty());
result = ApiUtil.getExampleResponse(exchange, "{ \"photoUrls\" : [ \"photoUrls\", \"photoUrls\" ], \"name\" : \"doggie\", \"id\" : 0, \"category\" : { \"name\" : \"name\", \"id\" : 6 }, \"tags\" : [ { \"name\" : \"name\", \"id\" : 1 }, { \"name\" : \"name\", \"id\" : 1 } ], \"status\" : \"available\"}");
break;
}
if (mediaType.isCompatibleWith(MediaType.valueOf("application/xml"))) {
result = ApiUtil.getExampleResponse(exchange, "<Pet> <id>123456789</id> <name>doggie</name> <photoUrls> <photoUrls>aeiou</photoUrls> </photoUrls> <tags> </tags> <status>aeiou</status></Pet>")
.then(Mono.empty());
result = ApiUtil.getExampleResponse(exchange, "<Pet> <id>123456789</id> <name>doggie</name> <photoUrls> <photoUrls>aeiou</photoUrls> </photoUrls> <tags> </tags> <status>aeiou</status></Pet>");
break;
}
}
return ResponseEntity.status(HttpStatus.NOT_IMPLEMENTED).body(result);
return result.then(Mono.empty());

}

Expand All @@ -174,9 +173,10 @@ default ResponseEntity<Mono<Pet>> getPetById(@ApiParam(value = "ID of pet to ret
@RequestMapping(value = "/pet",
consumes = { "application/json", "application/xml" },
method = RequestMethod.PUT)
default ResponseEntity<Mono<Void>> updatePet(@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Mono<Pet> pet, ServerWebExchange exchange) {
default Mono<ResponseEntity<Void>> updatePet(@ApiParam(value = "Pet object that needs to be added to the store" ,required=true ) @Valid @RequestBody Mono<Pet> pet, ServerWebExchange exchange) {
exchange.getResponse().setStatusCode(HttpStatus.NOT_IMPLEMENTED);
Mono<Void> result = Mono.empty();
return ResponseEntity.status(HttpStatus.NOT_IMPLEMENTED).body(pet.then(result));
return result.then(Mono.empty());

}

Expand All @@ -192,9 +192,10 @@ default ResponseEntity<Mono<Void>> updatePet(@ApiParam(value = "Pet object that
@RequestMapping(value = "/pet/{petId}",
consumes = { "application/x-www-form-urlencoded" },
method = RequestMethod.POST)
default ResponseEntity<Mono<Void>> updatePetWithForm(@ApiParam(value = "ID of pet that needs to be updated",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "Updated name of the pet", defaultValue="null") @RequestParam(value="name", required=false) String name,@ApiParam(value = "Updated status of the pet", defaultValue="null") @RequestParam(value="status", required=false) String status, ServerWebExchange exchange) {
default Mono<ResponseEntity<Void>> updatePetWithForm(@ApiParam(value = "ID of pet that needs to be updated",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "Updated name of the pet", defaultValue="null") @RequestParam(value="name", required=false) String name,@ApiParam(value = "Updated status of the pet", defaultValue="null") @RequestParam(value="status", required=false) String status, ServerWebExchange exchange) {
exchange.getResponse().setStatusCode(HttpStatus.NOT_IMPLEMENTED);
Mono<Void> result = Mono.empty();
return ResponseEntity.status(HttpStatus.NOT_IMPLEMENTED).body(result);
return result.then(Mono.empty());

}

Expand All @@ -211,16 +212,16 @@ default ResponseEntity<Mono<Void>> updatePetWithForm(@ApiParam(value = "ID of pe
produces = { "application/json" },
consumes = { "multipart/form-data" },
method = RequestMethod.POST)
default ResponseEntity<Mono<ModelApiResponse>> uploadFile(@ApiParam(value = "ID of pet to update",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "Additional data to pass to server", defaultValue="null") @RequestParam(value="additionalMetadata", required=false) String additionalMetadata,@ApiParam(value = "file detail") @Valid @RequestPart("file") MultipartFile file, ServerWebExchange exchange) {
Mono<ModelApiResponse> result = Mono.empty();
default Mono<ResponseEntity<ModelApiResponse>> uploadFile(@ApiParam(value = "ID of pet to update",required=true) @PathVariable("petId") Long petId,@ApiParam(value = "Additional data to pass to server", defaultValue="null") @RequestParam(value="additionalMetadata", required=false) String additionalMetadata,@ApiParam(value = "file detail") @Valid @RequestPart("file") MultipartFile file, ServerWebExchange exchange) {
exchange.getResponse().setStatusCode(HttpStatus.NOT_IMPLEMENTED);
Mono<Void> result = Mono.empty();
for (MediaType mediaType : exchange.getRequest().getHeaders().getAccept()) {
if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) {
result = ApiUtil.getExampleResponse(exchange, "{ \"code\" : 0, \"type\" : \"type\", \"message\" : \"message\"}")
.then(Mono.empty());
result = ApiUtil.getExampleResponse(exchange, "{ \"code\" : 0, \"type\" : \"type\", \"message\" : \"message\"}");
break;
}
}
return ResponseEntity.status(HttpStatus.NOT_IMPLEMENTED).body(result);
return result.then(Mono.empty());

}

Expand Down
Loading