Skip to content

Commit bf57d58

Browse files
fvladVladislav Fefelov
andauthored
Move Java Spring Springfox ApiIgnore under conditions (#9644)
* Remove SpringFox @ApiIgnore imports and reference class directly * Update generated sources Co-authored-by: Vladislav Fefelov <vladislavf@playtika.com>
1 parent f2b50fa commit bf57d58

145 files changed

Lines changed: 56 additions & 201 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

modules/openapi-generator/src/main/resources/JavaSpring/api.mustache

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@ import reactor.core.publisher.Flux;
3333
import reactor.core.publisher.Mono;
3434
import org.springframework.http.codec.multipart.Part;
3535
{{/reactive}}
36-
import springfox.documentation.annotations.ApiIgnore;
3736

3837
{{#useBeanValidation}}
3938
import javax.validation.Valid;
@@ -125,13 +124,13 @@ public interface {{classname}} {
125124
produces = { {{#produces}}"{{{mediaType}}}"{{^-last}}, {{/-last}}{{/produces}} }{{/hasProduces}}{{#hasConsumes}},
126125
consumes = { {{#consumes}}"{{{mediaType}}}"{{^-last}}, {{/-last}}{{/consumes}} }{{/hasConsumes}}{{/singleContentTypes}}
127126
)
128-
{{#jdk8-default-interface}}default {{/jdk8-default-interface}}{{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{#delegate-method}}_{{/delegate-method}}{{operationId}}({{#allParams}}{{>queryParams}}{{>pathParams}}{{>headerParams}}{{>bodyParams}}{{>formParams}}{{>cookieParams}}{{^-last}},{{/-last}}{{#-last}}{{#reactive}}, {{/reactive}}{{/-last}}{{/allParams}}{{#reactive}}@ApiIgnore final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}, @ApiIgnore final org.springframework.data.domain.Pageable pageable{{/vendorExtensions.x-spring-paginated}}){{^jdk8-default-interface}};{{/jdk8-default-interface}}{{#jdk8-default-interface}}{{#unhandledException}} throws Exception{{/unhandledException}} {
127+
{{#jdk8-default-interface}}default {{/jdk8-default-interface}}{{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{#delegate-method}}_{{/delegate-method}}{{operationId}}({{#allParams}}{{>queryParams}}{{>pathParams}}{{>headerParams}}{{>bodyParams}}{{>formParams}}{{>cookieParams}}{{^-last}},{{/-last}}{{#-last}}{{#reactive}}, {{/reactive}}{{/-last}}{{/allParams}}{{#reactive}}@springfox.documentation.annotations.ApiIgnore final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}, @springfox.documentation.annotations.ApiIgnore final org.springframework.data.domain.Pageable pageable{{/vendorExtensions.x-spring-paginated}}){{^jdk8-default-interface}};{{/jdk8-default-interface}}{{#jdk8-default-interface}}{{#unhandledException}} throws Exception{{/unhandledException}} {
129128
{{#delegate-method}}
130129
return {{operationId}}({{#allParams}}{{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}}, {{/hasParams}}exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}, pageable{{/vendorExtensions.x-spring-paginated}});
131130
}
132131

133132
// Override this method
134-
{{#jdk8-default-interface}}default {{/jdk8-default-interface}} {{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{operationId}}({{#allParams}}{{^isFile}}{{^isBodyParam}}{{>optionalDataType}}{{/isBodyParam}}{{#isBodyParam}}{{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isArray}}Mono<{{{dataType}}}>{{/isArray}}{{#isArray}}Flux<{{{baseType}}}>{{/isArray}}{{/reactive}}{{/isBodyParam}}{{/isFile}}{{#isFile}}{{#reactive}}Flux<Part>{{/reactive}}{{^reactive}}MultipartFile{{/reactive}}{{/isFile}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}}, {{/hasParams}}@ApiIgnore final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}, @ApiIgnore final org.springframework.data.domain.Pageable pageable{{/vendorExtensions.x-spring-paginated}}){{#unhandledException}} throws Exception{{/unhandledException}} {
133+
{{#jdk8-default-interface}}default {{/jdk8-default-interface}} {{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{operationId}}({{#allParams}}{{^isFile}}{{^isBodyParam}}{{>optionalDataType}}{{/isBodyParam}}{{#isBodyParam}}{{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isArray}}Mono<{{{dataType}}}>{{/isArray}}{{#isArray}}Flux<{{{baseType}}}>{{/isArray}}{{/reactive}}{{/isBodyParam}}{{/isFile}}{{#isFile}}{{#reactive}}Flux<Part>{{/reactive}}{{^reactive}}MultipartFile{{/reactive}}{{/isFile}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}}, {{/hasParams}}@springfox.documentation.annotations.ApiIgnore final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}, @springfox.documentation.annotations.ApiIgnore final org.springframework.data.domain.Pageable pageable{{/vendorExtensions.x-spring-paginated}}){{#unhandledException}} throws Exception{{/unhandledException}} {
135134
{{/delegate-method}}
136135
{{^isDelegate}}
137136
{{>methodBody}}

modules/openapi-generator/src/main/resources/JavaSpring/apiController.mustache

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ import org.springframework.web.multipart.MultipartFile;
2828
{{#vendorExtensions.x-spring-paginated}}
2929
import org.springframework.data.domain.Pageable;
3030
{{/vendorExtensions.x-spring-paginated}}
31-
import springfox.documentation.annotations.ApiIgnore;
3231

3332
{{#useBeanValidation}}
3433
import javax.validation.constraints.*;
@@ -114,7 +113,7 @@ public class {{classname}}Controller implements {{classname}} {
114113
{{/externalDocs}}
115114
* @see {{classname}}#{{operationId}}
116115
*/
117-
public {{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{operationId}}({{#allParams}}{{>queryParams}}{{>pathParams}}{{>headerParams}}{{>bodyParams}}{{>formParams}}{{>cookieParams}}{{^-last}},{{/-last}}{{/allParams}}{{#vendorExtensions.x-spring-paginated}}, @ApiIgnore final Pageable pageable{{/vendorExtensions.x-spring-paginated}}) {
116+
public {{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{operationId}}({{#allParams}}{{>queryParams}}{{>pathParams}}{{>headerParams}}{{>bodyParams}}{{>formParams}}{{>cookieParams}}{{^-last}},{{/-last}}{{/allParams}}{{#vendorExtensions.x-spring-paginated}}, @springfox.documentation.annotations.ApiIgnore final Pageable pageable{{/vendorExtensions.x-spring-paginated}}) {
118117
{{^isDelegate}}
119118
{{^async}}
120119
{{>methodBody}}

samples/client/petstore/spring-cloud-async/src/main/java/org/openapitools/api/PetApi.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
import org.springframework.web.bind.annotation.*;
1616
import org.springframework.web.context.request.NativeWebRequest;
1717
import org.springframework.web.multipart.MultipartFile;
18-
import springfox.documentation.annotations.ApiIgnore;
1918

2019
import javax.validation.Valid;
2120
import javax.validation.constraints.*;

samples/client/petstore/spring-cloud-async/src/main/java/org/openapitools/api/StoreApi.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
import org.springframework.web.bind.annotation.*;
1616
import org.springframework.web.context.request.NativeWebRequest;
1717
import org.springframework.web.multipart.MultipartFile;
18-
import springfox.documentation.annotations.ApiIgnore;
1918

2019
import javax.validation.Valid;
2120
import javax.validation.constraints.*;

samples/client/petstore/spring-cloud-async/src/main/java/org/openapitools/api/UserApi.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
import org.springframework.web.bind.annotation.*;
1616
import org.springframework.web.context.request.NativeWebRequest;
1717
import org.springframework.web.multipart.MultipartFile;
18-
import springfox.documentation.annotations.ApiIgnore;
1918

2019
import javax.validation.Valid;
2120
import javax.validation.constraints.*;

samples/client/petstore/spring-cloud-no-nullable/src/main/java/org/openapitools/api/PetApi.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
import org.springframework.web.bind.annotation.*;
1616
import org.springframework.web.context.request.NativeWebRequest;
1717
import org.springframework.web.multipart.MultipartFile;
18-
import springfox.documentation.annotations.ApiIgnore;
1918

2019
import javax.validation.Valid;
2120
import javax.validation.constraints.*;

samples/client/petstore/spring-cloud-no-nullable/src/main/java/org/openapitools/api/StoreApi.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
import org.springframework.web.bind.annotation.*;
1616
import org.springframework.web.context.request.NativeWebRequest;
1717
import org.springframework.web.multipart.MultipartFile;
18-
import springfox.documentation.annotations.ApiIgnore;
1918

2019
import javax.validation.Valid;
2120
import javax.validation.constraints.*;

samples/client/petstore/spring-cloud-no-nullable/src/main/java/org/openapitools/api/UserApi.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
import org.springframework.web.bind.annotation.*;
1616
import org.springframework.web.context.request.NativeWebRequest;
1717
import org.springframework.web.multipart.MultipartFile;
18-
import springfox.documentation.annotations.ApiIgnore;
1918

2019
import javax.validation.Valid;
2120
import javax.validation.constraints.*;

samples/client/petstore/spring-cloud-spring-pageable/src/main/java/org/openapitools/api/PetApi.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
import org.springframework.web.bind.annotation.*;
1616
import org.springframework.web.context.request.NativeWebRequest;
1717
import org.springframework.web.multipart.MultipartFile;
18-
import springfox.documentation.annotations.ApiIgnore;
1918

2019
import javax.validation.Valid;
2120
import javax.validation.constraints.*;
@@ -90,7 +89,7 @@ public interface PetApi {
9089
value = "/pet/findByStatus",
9190
produces = "application/json"
9291
)
93-
ResponseEntity<List<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, @ApiIgnore final org.springframework.data.domain.Pageable pageable);
92+
ResponseEntity<List<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, @springfox.documentation.annotations.ApiIgnore final org.springframework.data.domain.Pageable pageable);
9493

9594

9695
/**
@@ -115,7 +114,7 @@ public interface PetApi {
115114
value = "/pet/findByTags",
116115
produces = "application/json"
117116
)
118-
ResponseEntity<List<Pet>> findPetsByTags(@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) List<String> tags, @ApiIgnore final org.springframework.data.domain.Pageable pageable);
117+
ResponseEntity<List<Pet>> findPetsByTags(@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) List<String> tags, @springfox.documentation.annotations.ApiIgnore final org.springframework.data.domain.Pageable pageable);
119118

120119

121120
/**

samples/client/petstore/spring-cloud-spring-pageable/src/main/java/org/openapitools/api/StoreApi.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
import org.springframework.web.bind.annotation.*;
1616
import org.springframework.web.context.request.NativeWebRequest;
1717
import org.springframework.web.multipart.MultipartFile;
18-
import springfox.documentation.annotations.ApiIgnore;
1918

2019
import javax.validation.Valid;
2120
import javax.validation.constraints.*;

0 commit comments

Comments
 (0)