Skip to content

Commit db59785

Browse files
wing328wing328
authored
Remove springfox from templates (#23284)
* remove springFox from spring templates * remove springFox from kotlins spring templates * fix * update samples * update * remove use swagger ui tag
1 parent f631d54 commit db59785

File tree

17 files changed

+55
-145
lines changed

17 files changed

+55
-145
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -278,17 +278,17 @@ public interface {{classname}} {
278278
{{#jdk8-default-interface}}default {{/jdk8-default-interface}}{{>responseType}} {{#delegate-method}}_{{/delegate-method}}{{operationId}}(
279279
{{#allParams}}{{>queryParams}}{{>pathParams}}{{>headerParams}}{{>bodyParams}}{{>formParams}}{{>cookieParams}}{{^-last}},
280280
{{/-last}}{{/allParams}}{{#includeHttpRequestContext}}{{#hasParams}},
281-
{{/hasParams}}{{#swagger2AnnotationLibrary}}@Parameter(hidden = true){{/swagger2AnnotationLibrary}}{{#springFoxDocumentationProvider}}@ApiIgnore{{/springFoxDocumentationProvider}} final {{#reactive}}ServerWebExchange exchange{{/reactive}}{{^reactive}}HttpServletRequest servletRequest{{/reactive}}{{/includeHttpRequestContext}}{{#vendorExtensions.x-spring-paginated}}{{#hasParams}},
282-
{{/hasParams}}{{^hasParams}}{{#includeHttpRequestContext}},{{/includeHttpRequestContext}}{{/hasParams}}{{#springFoxDocumentationProvider}}@ApiIgnore{{/springFoxDocumentationProvider}}{{#springDocDocumentationProvider}}@ParameterObject{{/springDocDocumentationProvider}} final Pageable pageable{{/vendorExtensions.x-spring-paginated}}{{#vendorExtensions.x-spring-provide-args}}{{#hasParams}},
283-
{{/hasParams}}{{^hasParams}}{{#includeHttpRequestContext}},{{/includeHttpRequestContext}}{{/hasParams}}{{#swagger2AnnotationLibrary}}@Parameter(hidden = true){{/swagger2AnnotationLibrary}}{{#springFoxDocumentationProvider}}@ApiIgnore{{/springFoxDocumentationProvider}} {{{.}}}{{^hasParams}}{{^-last}}{{^reactive}},{{/reactive}}
281+
{{/hasParams}}{{#swagger2AnnotationLibrary}}@Parameter(hidden = true){{/swagger2AnnotationLibrary}} final {{#reactive}}ServerWebExchange exchange{{/reactive}}{{^reactive}}HttpServletRequest servletRequest{{/reactive}}{{/includeHttpRequestContext}}{{#vendorExtensions.x-spring-paginated}}{{#hasParams}},
282+
{{/hasParams}}{{^hasParams}}{{#includeHttpRequestContext}},{{/includeHttpRequestContext}}{{/hasParams}}{{#springDocDocumentationProvider}}@ParameterObject{{/springDocDocumentationProvider}} final Pageable pageable{{/vendorExtensions.x-spring-paginated}}{{#vendorExtensions.x-spring-provide-args}}{{#hasParams}},
283+
{{/hasParams}}{{^hasParams}}{{#includeHttpRequestContext}},{{/includeHttpRequestContext}}{{/hasParams}}{{#swagger2AnnotationLibrary}}@Parameter(hidden = true){{/swagger2AnnotationLibrary}} {{{.}}}{{^hasParams}}{{^-last}}{{^reactive}},{{/reactive}}
284284
{{/-last}}{{/hasParams}}{{/vendorExtensions.x-spring-provide-args}}
285285
){{#unhandledException}} throws Exception{{/unhandledException}}{{^jdk8-default-interface}};{{/jdk8-default-interface}}{{#jdk8-default-interface}} {
286286
{{#delegate-method}}
287287
{{^isVoid}}return {{/isVoid}}{{#isVoid}}{{#useResponseEntity}}return {{/useResponseEntity}}{{^useResponseEntity}}{{#reactive}}return {{/reactive}}{{/useResponseEntity}}{{/isVoid}}{{operationId}}({{#allParams}}{{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#includeHttpRequestContext}}{{#hasParams}}, {{/hasParams}}{{#reactive}}exchange{{/reactive}}{{^reactive}}servletRequest{{/reactive}}{{/includeHttpRequestContext}}{{#vendorExtensions.x-spring-paginated}}{{#hasParams}}, {{/hasParams}}{{^hasParams}}{{#reactive}}, {{/reactive}}{{/hasParams}}pageable{{/vendorExtensions.x-spring-paginated}});
288288
}
289289

290290
// Override this method
291-
{{#jdk8-default-interface}}default {{/jdk8-default-interface}} {{>responseType}} {{operationId}}({{#allParams}}{{^isFile}}{{^isBodyParam}}{{>optionalDataType}}{{/isBodyParam}}{{#isBodyParam}}{{^reactive}}{{>optionalDataType}}{{/reactive}}{{#reactive}}{{^isArray}}Mono<{{{dataType}}}>{{/isArray}}{{#isArray}}Flux<{{{baseType}}}>{{/isArray}}{{/reactive}}{{/isBodyParam}}{{/isFile}}{{#isFile}}{{#reactive}}{{#isArray}}Flux<{{/isArray}}Part{{#isArray}}>{{/isArray}}{{/reactive}}{{^reactive}}{{#isArray}}List<{{/isArray}}MultipartFile{{#isArray}}>{{/isArray}}{{/reactive}}{{/isFile}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#includeHttpRequestContext}}{{#hasParams}}, {{/hasParams}}{{#springFoxDocumentationProvider}}@ApiIgnore{{/springFoxDocumentationProvider}} final {{#reactive}}ServerWebExchange exchange{{/reactive}}{{^reactive}}HttpServletRequest servletRequest{{/reactive}}{{/includeHttpRequestContext}}{{#vendorExtensions.x-spring-paginated}}{{#hasParams}}, {{/hasParams}}{{^hasParams}}{{#reactive}}, {{/reactive}}{{/hasParams}}{{#springFoxDocumentationProvider}}@ApiIgnore{{/springFoxDocumentationProvider}}final Pageable pageable{{/vendorExtensions.x-spring-paginated}}){{#unhandledException}} throws Exception{{/unhandledException}} {
291+
{{#jdk8-default-interface}}default {{/jdk8-default-interface}} {{>responseType}} {{operationId}}({{#allParams}}{{^isFile}}{{^isBodyParam}}{{>optionalDataType}}{{/isBodyParam}}{{#isBodyParam}}{{^reactive}}{{>optionalDataType}}{{/reactive}}{{#reactive}}{{^isArray}}Mono<{{{dataType}}}>{{/isArray}}{{#isArray}}Flux<{{{baseType}}}>{{/isArray}}{{/reactive}}{{/isBodyParam}}{{/isFile}}{{#isFile}}{{#reactive}}{{#isArray}}Flux<{{/isArray}}Part{{#isArray}}>{{/isArray}}{{/reactive}}{{^reactive}}{{#isArray}}List<{{/isArray}}MultipartFile{{#isArray}}>{{/isArray}}{{/reactive}}{{/isFile}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#includeHttpRequestContext}}{{#hasParams}}, {{/hasParams}} final {{#reactive}}ServerWebExchange exchange{{/reactive}}{{^reactive}}HttpServletRequest servletRequest{{/reactive}}{{/includeHttpRequestContext}}{{#vendorExtensions.x-spring-paginated}}{{#hasParams}}, {{/hasParams}}{{^hasParams}}{{#reactive}}, {{/reactive}}{{/hasParams}}final Pageable pageable{{/vendorExtensions.x-spring-paginated}}){{#unhandledException}} throws Exception{{/unhandledException}} {
292292
{{/delegate-method}}
293293
{{^isDelegate}}
294294
{{>methodBody}}{{! prevent indent}}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ public class {{classname}}Controller implements {{classname}} {
123123
public {{#responseWrapper}}{{.}}<{{/responseWrapper}}{{#useResponseEntity}}ResponseEntity<{{/useResponseEntity}}{{>returnTypes}}{{#useResponseEntity}}>{{/useResponseEntity}}{{#responseWrapper}}>{{/responseWrapper}} {{operationId}}(
124124
{{#allParams}}{{>queryParams}}{{>pathParams}}{{>headerParams}}{{>bodyParams}}{{>formParams}}{{>cookieParams}}{{^-last}},
125125
{{/-last}}{{/allParams}}{{#vendorExtensions.x-spring-paginated}}{{#hasParams}},
126-
{{/hasParams}}{{^hasParams}}{{#reactive}},{{/reactive}}{{/hasParams}}{{#springFoxDocumentationProvider}}@ApiIgnore {{/springFoxDocumentationProvider}}{{#springDocDocumentationProvider}}@ParameterObject {{/springDocDocumentationProvider}}final Pageable pageable{{/vendorExtensions.x-spring-paginated}}
126+
{{/hasParams}}{{^hasParams}}{{#reactive}},{{/reactive}}{{/hasParams}}{{#springDocDocumentationProvider}}@ParameterObject {{/springDocDocumentationProvider}}final Pageable pageable{{/vendorExtensions.x-spring-paginated}}
127127
) {
128128
{{^isDelegate}}
129129
{{^async}}

‎modules/openapi-generator/src/main/resources/JavaSpring/homeController.mustache‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,6 @@ public class HomeController {
7272
{{#sourceDocumentationProvider}}
7373
static final String API_DOCS_PATH = "/openapi.json";
7474
{{/sourceDocumentationProvider}}
75-
{{#springFoxDocumentationProvider}}
76-
static final String API_DOCS_PATH = "/v2/api-docs";
77-
{{/springFoxDocumentationProvider}}
7875

7976
@GetMapping(value = "/swagger-config.yaml", produces = "text/plain")
8077
@ResponseBody

‎modules/openapi-generator/src/main/resources/JavaSpring/libraries/spring-boot/README.mustache‎

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,6 @@ Spring Boot Server
66
This server was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.
77
By using the [OpenAPI-Spec](https://openapis.org), you can easily generate a server stub.
88
This is an example of building a OpenAPI-enabled server in Java using the SpringBoot framework.
9-
{{#springFoxDocumentationProvider}}
10-
11-
The underlying library integrating OpenAPI to Spring Boot is [springfox](https://github.com/springfox/springfox).
12-
Springfox will generate an OpenAPI v2 (fka Swagger RESTful API Documentation Specification) specification based on the
13-
generated Controller and Model classes. The specification is available to download using the following url:
14-
http://localhost:{{serverPort}}/v2/api-docs/
15-
16-
**HEADS-UP**: Springfox is deprecated for removal in version 6.0.0 of openapi-generator. The project seems to be no longer
17-
maintained (last commit is of Oct 14, 2020). It works with Spring Boot 2.5.x but not with 2.6. Spring Boot 2.5 is
18-
supported until 2022-05-19. Users of openapi-generator should migrate to the springdoc documentation provider which is,
19-
as an added bonus, OpenAPI v3 compatible.
20-
21-
{{/springFoxDocumentationProvider}}
229

2310
{{#springDocDocumentationProvider}}
2411

‎modules/openapi-generator/src/main/resources/JavaSpring/libraries/spring-boot/pom.mustache‎

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,9 @@
1515
<maven.compiler.source>${java.version}</maven.compiler.source>
1616
<maven.compiler.target>${java.version}</maven.compiler.target>
1717
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
18-
{{#springFoxDocumentationProvider}}
19-
<springfox.version>2.9.2</springfox.version>
20-
{{/springFoxDocumentationProvider}}
2118
{{#springDocDocumentationProvider}}
2219
<springdoc.version>1.6.14</springdoc.version>
2320
{{/springDocDocumentationProvider}}
24-
{{^springFoxDocumentationProvider}}
2521
{{^springDocDocumentationProvider}}
2622
{{#swagger1AnnotationLibrary}}
2723
<swagger-annotations.version>1.6.6</swagger-annotations.version>
@@ -30,7 +26,6 @@
3026
<swagger-annotations.version>2.2.7</swagger-annotations.version>
3127
{{/swagger2AnnotationLibrary}}
3228
{{/springDocDocumentationProvider}}
33-
{{/springFoxDocumentationProvider}}
3429
{{#virtualService}}
3530
<virtualan.version>2.5.2</virtualan.version>
3631
{{/virtualService}}
@@ -49,7 +44,7 @@
4944
<parent>
5045
<groupId>org.springframework.boot</groupId>
5146
<artifactId>spring-boot-starter-parent</artifactId>
52-
<version>{{#springFoxDocumentationProvider}}2.5.14{{/springFoxDocumentationProvider}}{{^springFoxDocumentationProvider}}2.7.15{{/springFoxDocumentationProvider}}</version>
47+
<version>2.7.15</version>
5348
<relativePath/> <!-- lookup parent from repository -->
5449
</parent>
5550
{{/parentOverridden}}
@@ -149,14 +144,6 @@
149144
</dependency>
150145
{{/useSwaggerUI}}
151146
{{/springDocDocumentationProvider}}
152-
{{#springFoxDocumentationProvider}}
153-
<!--SpringFox dependencies -->
154-
<dependency>
155-
<groupId>io.springfox</groupId>
156-
<artifactId>springfox-swagger2</artifactId>
157-
<version>${springfox.version}</version>
158-
</dependency>
159-
{{/springFoxDocumentationProvider}}
160147
{{#useSwaggerUI}}
161148
{{^springDocDocumentationProvider}}
162149
<dependency>
@@ -170,7 +157,6 @@
170157
</dependency>
171158
{{/springDocDocumentationProvider}}
172159
{{/useSwaggerUI}}
173-
{{^springFoxDocumentationProvider}}
174160
{{^springDocDocumentationProvider}}
175161
{{#swagger1AnnotationLibrary}}
176162
<dependency>
@@ -187,7 +173,6 @@
187173
</dependency>
188174
{{/swagger2AnnotationLibrary}}
189175
{{/springDocDocumentationProvider}}
190-
{{/springFoxDocumentationProvider}}
191176
<!-- @Nullable annotation -->
192177
<dependency>
193178
<groupId>com.google.code.findbugs</groupId>

‎modules/openapi-generator/src/main/resources/JavaSpring/libraries/spring-cloud/pom.mustache‎

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,9 @@
1515
<maven.compiler.source>${java.version}</maven.compiler.source>
1616
<maven.compiler.target>${java.version}</maven.compiler.target>
1717
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
18-
{{#springFoxDocumentationProvider}}
19-
<springfox.version>2.9.2</springfox.version>
20-
{{/springFoxDocumentationProvider}}
2118
{{#springDocDocumentationProvider}}
2219
<springdoc.version>1.6.14</springdoc.version>
2320
{{/springDocDocumentationProvider}}
24-
{{^springFoxDocumentationProvider}}
2521
{{^springDocDocumentationProvider}}
2622
{{#swagger1AnnotationLibrary}}
2723
<swagger-annotations.version>1.6.6</swagger-annotations.version>
@@ -30,7 +26,6 @@
3026
<swagger-annotations.version>2.2.7</swagger-annotations.version>
3127
{{/swagger2AnnotationLibrary}}
3228
{{/springDocDocumentationProvider}}
33-
{{/springFoxDocumentationProvider}}
3429
</properties>
3530
{{#parentOverridden}}
3631
<parent>
@@ -88,15 +83,6 @@
8883
<version>${springdoc.version}</version>
8984
</dependency>
9085
{{/springDocDocumentationProvider}}
91-
{{#springFoxDocumentationProvider}}
92-
<!--SpringFox dependencies -->
93-
<dependency>
94-
<groupId>io.springfox</groupId>
95-
<artifactId>springfox-swagger2</artifactId>
96-
<version>${springfox.version}</version>
97-
</dependency>
98-
{{/springFoxDocumentationProvider}}
99-
{{^springFoxDocumentationProvider}}
10086
{{^springDocDocumentationProvider}}
10187
{{#swagger1AnnotationLibrary}}
10288
<dependency>
@@ -113,7 +99,6 @@
11399
</dependency>
114100
{{/swagger2AnnotationLibrary}}
115101
{{/springDocDocumentationProvider}}
116-
{{/springFoxDocumentationProvider}}
117102
<!-- @Nullable annotation -->
118103
<dependency>
119104
<groupId>com.google.code.findbugs</groupId>

‎modules/openapi-generator/src/main/resources/kotlin-spring/homeController.mustache‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,6 @@ class HomeController {
3939
{{#sourceDocumentationProvider}}
4040
private val apiDocsPath = "/openapi.json"
4141
{{/sourceDocumentationProvider}}
42-
{{#springFoxDocumentationProvider}}
43-
private val apiDocsPath = "/v2/api-docs"
44-
{{/springFoxDocumentationProvider}}
4542
{{/springDocDocumentationProvider}}
4643
{{/useSwaggerUI}}
4744
{{#sourceDocumentationProvider}}

‎modules/openapi-generator/src/main/resources/kotlin-spring/libraries/spring-boot/buildGradle-sb3-Kts.mustache‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,11 @@ dependencies {
3737
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:$kotlinxCoroutinesVersion")
3838
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-reactor:$kotlinxCoroutinesVersion"){{/reactive}}{{#springDocDocumentationProvider}}{{#useSwaggerUI}}
3939
implementation("org.springdoc:springdoc-openapi-starter-{{#reactive}}webflux{{/reactive}}{{^reactive}}webmvc{{/reactive}}-ui:2.6.0"){{/useSwaggerUI}}{{^useSwaggerUI}}
40-
implementation("org.springdoc:springdoc-openapi-starter-{{#reactive}}webflux{{/reactive}}{{^reactive}}webmvc{{/reactive}}-api:2.6.0"){{/useSwaggerUI}}{{/springDocDocumentationProvider}}{{#springFoxDocumentationProvider}}
41-
implementation("io.springfox:springfox-swagger2:2.9.2"){{/springFoxDocumentationProvider}}{{#useSwaggerUI}}{{^springDocDocumentationProvider}}
40+
implementation("org.springdoc:springdoc-openapi-starter-{{#reactive}}webflux{{/reactive}}{{^reactive}}webmvc{{/reactive}}-api:2.6.0"){{/useSwaggerUI}}{{/springDocDocumentationProvider}}{{#useSwaggerUI}}{{^springDocDocumentationProvider}}
4241
implementation("org.webjars:swagger-ui:4.10.3")
43-
implementation("org.webjars:webjars-locator-core"){{/springDocDocumentationProvider}}{{/useSwaggerUI}}{{^springFoxDocumentationProvider}}{{^springDocDocumentationProvider}}{{#swagger1AnnotationLibrary}}
42+
implementation("org.webjars:webjars-locator-core"){{/springDocDocumentationProvider}}{{/useSwaggerUI}}{{^springDocDocumentationProvider}}{{#swagger1AnnotationLibrary}}
4443
implementation("io.swagger:swagger-annotations:1.6.6"){{/swagger1AnnotationLibrary}}{{#swagger2AnnotationLibrary}}
45-
implementation("io.swagger.core.v3:swagger-annotations:2.2.0"){{/swagger2AnnotationLibrary}}{{/springDocDocumentationProvider}}{{/springFoxDocumentationProvider}}
44+
implementation("io.swagger.core.v3:swagger-annotations:2.2.0"){{/swagger2AnnotationLibrary}}{{/springDocDocumentationProvider}}
4645

4746
implementation("com.google.code.findbugs:jsr305:3.0.2")
4847
implementation("com.fasterxml.jackson.dataformat:jackson-dataformat-yaml")

‎modules/openapi-generator/src/main/resources/kotlin-spring/libraries/spring-boot/buildGradleKts.mustache‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,11 @@ dependencies {
4444
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:$kotlinxCoroutinesVersion")
4545
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-reactor:$kotlinxCoroutinesVersion"){{/reactive}}{{#springDocDocumentationProvider}}{{#useSwaggerUI}}
4646
implementation("org.springdoc:springdoc-openapi-{{#reactive}}webflux-{{/reactive}}ui:1.6.8"){{/useSwaggerUI}}{{^useSwaggerUI}}
47-
implementation("org.springdoc:springdoc-openapi-{{#reactive}}webflux{{/reactive}}{{^reactive}}webmvc{{/reactive}}-core:1.6.8"){{/useSwaggerUI}}{{/springDocDocumentationProvider}}{{#springFoxDocumentationProvider}}
48-
implementation("io.springfox:springfox-swagger2:2.9.2"){{/springFoxDocumentationProvider}}{{#useSwaggerUI}}{{^springDocDocumentationProvider}}
47+
implementation("org.springdoc:springdoc-openapi-{{#reactive}}webflux{{/reactive}}{{^reactive}}webmvc{{/reactive}}-core:1.6.8"){{/useSwaggerUI}}{{/springDocDocumentationProvider}}{{#useSwaggerUI}}{{^springDocDocumentationProvider}}
4948
implementation("org.webjars:swagger-ui:4.10.3")
50-
implementation("org.webjars:webjars-locator-core"){{/springDocDocumentationProvider}}{{/useSwaggerUI}}{{^springFoxDocumentationProvider}}{{^springDocDocumentationProvider}}{{#swagger1AnnotationLibrary}}
49+
implementation("org.webjars:webjars-locator-core"){{/springDocDocumentationProvider}}{{/useSwaggerUI}}{{^springDocDocumentationProvider}}{{#swagger1AnnotationLibrary}}
5150
implementation("io.swagger:swagger-annotations:1.6.6"){{/swagger1AnnotationLibrary}}{{#swagger2AnnotationLibrary}}
52-
implementation("io.swagger.core.v3:swagger-annotations:2.2.0"){{/swagger2AnnotationLibrary}}{{/springDocDocumentationProvider}}{{/springFoxDocumentationProvider}}
51+
implementation("io.swagger.core.v3:swagger-annotations:2.2.0"){{/swagger2AnnotationLibrary}}{{/springDocDocumentationProvider}}
5352

5453
implementation("com.google.code.findbugs:jsr305:3.0.2")
5554
implementation("com.fasterxml.jackson.dataformat:jackson-dataformat-yaml")

0 commit comments

Comments
 (0)