Skip to content

Commit bbc697c

Browse files
panos-kakospanos-kakos
authored
[JAVA-40699] Moving some article links on Github - spring-boot-swagger (#18369)
1 parent 8955dce commit bbc697c

File tree

15 files changed

+231
-123
lines changed

15 files changed

+231
-123
lines changed

‎spring-boot-modules/spring-boot-swagger-2/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
- [Swagger: Specify Two Responses with the Same Response Code](https://www.baeldung.com/swagger-two-responses-one-response-code)
44
- [Specify an Array of Strings as Body Parameters in Swagger](https://www.baeldung.com/swagger-body-array-of-strings)
5-
- [Swagger @Parameter vs @Schema](https://www.baeldung.com/swagger-parameter-vs-schema)
6-
- [Map Date Types With OpenAPI Generator](https://www.baeldung.com/openapi-map-date-types)
75
- [API First Development with Spring Boot and OpenAPI 3.0](https://www.baeldung.com/spring-boot-openapi-api-first-development)
86
- [Swagger @ApiParam vs @ApiModelProperty](https://www.baeldung.com/swagger-apiparam-vs-apimodelproperty)
7+
- [Document Enum in Swagger](https://www.baeldung.com/swagger-enum)
8+
- More articles: [[<-- Prev]](../spring-boot-swagger)

‎spring-boot-modules/spring-boot-swagger-2/pom.xml

Lines changed: 51 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,16 @@
3939
<artifactId>jackson-databind-nullable</artifactId>
4040
<version>${jackson-databind-nullable}</version>
4141
</dependency>
42+
<dependency>
43+
<groupId>com.github.kongchen</groupId>
44+
<artifactId>swagger-maven-plugin</artifactId>
45+
<version>${swagger-maven-plugin.version}</version>
46+
</dependency>
47+
<dependency>
48+
<groupId>jakarta.ws.rs</groupId>
49+
<artifactId>jakarta.ws.rs-api</artifactId>
50+
<version>${jakarta.ws.rs-api.version}</version>
51+
</dependency>
4252
</dependencies>
4353

4454
<build>
@@ -64,30 +74,6 @@
6474
</configOptions>
6575
</configuration>
6676
</execution>
67-
<execution>
68-
<id>dates</id>
69-
<goals>
70-
<goal>generate</goal>
71-
</goals>
72-
<configuration>
73-
<inputSpec>${project.basedir}/src/main/resources/static/event.yaml</inputSpec>
74-
<language>spring</language>
75-
<configOptions>
76-
<java8>true</java8>
77-
<dateLibrary>custom</dateLibrary>
78-
<jakarta>true</jakarta>
79-
<useSpringBoot3>true</useSpringBoot3>
80-
</configOptions>
81-
<typeMappings>
82-
<typeMapping>DateTime=Instant</typeMapping>
83-
<typeMapping>Date=Date</typeMapping>
84-
</typeMappings>
85-
<importMappings>
86-
<importMapping>Instant=java.time.Instant</importMapping>
87-
<importMapping>Date=java.util.Date</importMapping>
88-
</importMappings>
89-
</configuration>
90-
</execution>
9177
</executions>
9278
</plugin>
9379
<plugin>
@@ -101,7 +87,6 @@
10187
</goals>
10288
<configuration>
10389
<skipValidateSpec>true</skipValidateSpec>
104-
<inputSpec>${project.basedir}/src/main/resources/static/event.yaml</inputSpec>
10590
<inputSpec>${project.basedir}/src/main/resources/static/account_api_description.yaml</inputSpec>
10691
<generatorName>spring</generatorName>
10792
<configOptions>
@@ -124,6 +109,44 @@
124109
</execution>
125110
</executions>
126111
</plugin>
112+
<plugin>
113+
<groupId>com.github.kongchen</groupId>
114+
<artifactId>swagger-maven-plugin</artifactId>
115+
<version>${swagger-maven-plugin.version}</version>
116+
<configuration>
117+
<apiSources>
118+
<apiSource>
119+
<springmvc>false</springmvc>
120+
<locations>com.baeldung.swaggerenums.controller</locations>
121+
<schemes>http,https</schemes>
122+
<host>baeldung.com</host>
123+
<basePath>/api</basePath>
124+
<info>
125+
<title>Baeldung - Document Enum</title>
126+
<version>v1</version>
127+
<description>This is a Baeldung Document Enum Sample Code</description>
128+
<contact>
129+
<email>[email protected]</email>
130+
<name>Parikshit Murria</name>
131+
</contact>
132+
<license>
133+
<url>https://www.apache.org/licenses/LICENSE-2.0.html</url>
134+
<name>Apache 2.0</name>
135+
</license>
136+
</info>
137+
<swaggerDirectory>${basedir}/target/swagger-ui</swaggerDirectory>
138+
</apiSource>
139+
</apiSources>
140+
</configuration>
141+
<executions>
142+
<execution>
143+
<phase>compile</phase>
144+
<goals>
145+
<goal>generate</goal>
146+
</goals>
147+
</execution>
148+
</executions>
149+
</plugin>
127150
<plugin>
128151
<groupId>org.springframework.boot</groupId>
129152
<artifactId>spring-boot-maven-plugin</artifactId>
@@ -140,6 +163,9 @@
140163
<swagger-codegen-maven-plugin.version>3.0.67</swagger-codegen-maven-plugin.version>
141164
<springdoc.version>1.8.0</springdoc.version>
142165
<swagger-annotations.version>2.2.28</swagger-annotations.version>
166+
<swagger-maven-plugin.version>3.1.1</swagger-maven-plugin.version>
167+
<springdoc.version>1.7.0</springdoc.version>
168+
<jakarta.ws.rs-api.version>3.1.0</jakarta.ws.rs-api.version>
143169
<start-class>com.baeldung.tworesponses.Application</start-class>
144170
</properties>
145171

‎spring-boot-modules/spring-boot-swagger/src/main/java/com/baeldung/swaggerenums/SwaggerEnumsApplication.java renamed to ‎spring-boot-modules/spring-boot-swagger-2/src/main/java/com/baeldung/swaggerenums/SwaggerEnumsApplication.java

File renamed without changes.

‎spring-boot-modules/spring-boot-swagger/src/main/java/com/baeldung/swaggerenums/controller/HireController.java renamed to ‎spring-boot-modules/spring-boot-swagger-2/src/main/java/com/baeldung/swaggerenums/controller/HireController.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
package com.baeldung.swaggerenums.controller;
22

33
import com.baeldung.swaggerenums.model.Employee;
4+
45
import io.swagger.annotations.Api;
56
import io.swagger.annotations.ApiOperation;
67
import io.swagger.annotations.ApiParam;
7-
88
import jakarta.ws.rs.POST;
99
import jakarta.ws.rs.Path;
1010
import jakarta.ws.rs.Produces;

‎spring-boot-modules/spring-boot-swagger/src/main/java/com/baeldung/swaggerenums/model/Employee.java renamed to ‎spring-boot-modules/spring-boot-swagger-2/src/main/java/com/baeldung/swaggerenums/model/Employee.java

File renamed without changes.

‎spring-boot-modules/spring-boot-swagger/src/main/java/com/baeldung/swaggerenums/model/Role.java renamed to ‎spring-boot-modules/spring-boot-swagger-2/src/main/java/com/baeldung/swaggerenums/model/Role.java

File renamed without changes.

‎spring-boot-modules/spring-boot-swagger/src/test/java/com/baeldung/swaggerenums/controller/HireControllerUnitTest.java renamed to ‎spring-boot-modules/spring-boot-swagger-2/src/test/java/com/baeldung/swaggerenums/controller/HireControllerUnitTest.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
package com.baeldung.swaggerenums.controller;
22

3-
import com.baeldung.swaggerenums.model.Employee;
4-
import com.baeldung.swaggerenums.model.Role;
53
import org.junit.Assert;
64
import org.junit.Test;
75

6+
import com.baeldung.swaggerenums.model.Employee;
7+
import com.baeldung.swaggerenums.model.Role;
8+
89
public class HireControllerUnitTest {
910

1011
@Test

‎spring-boot-modules/spring-boot-swagger/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,7 @@
22

33
- [Generate PDF from Swagger API Documentation](https://www.baeldung.com/swagger-generate-pdf)
44
- [Setting Example and Description with Swagger](https://www.baeldung.com/swagger-set-example-description)
5-
- [Document Enum in Swagger](https://www.baeldung.com/swagger-enum)
65
- [@Operation vs @ApiResponse in Swagger](https://www.baeldung.com/swagger-operation-vs-apiresponse)
6+
- [Swagger @Parameter vs @Schema](https://www.baeldung.com/swagger-parameter-vs-schema)
7+
- [Map Date Types With OpenAPI Generator](https://www.baeldung.com/openapi-map-date-types)
8+
- More articles: [[Next -->]](../spring-boot-swagger-2)

‎spring-boot-modules/spring-boot-swagger/pom.xml

Lines changed: 78 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,30 @@
2020
<groupId>org.springframework.boot</groupId>
2121
<artifactId>spring-boot-starter-web</artifactId>
2222
</dependency>
23-
<dependency>
24-
<groupId>com.github.kongchen</groupId>
25-
<artifactId>swagger-maven-plugin</artifactId>
26-
<version>${swagger-maven-plugin.version}</version>
27-
</dependency>
2823
<dependency>
2924
<groupId>org.springdoc</groupId>
3025
<artifactId>springdoc-openapi-ui</artifactId>
3126
<version>${springdoc.version}</version>
3227
</dependency>
28+
<dependency>
29+
<groupId>org.springframework.boot</groupId>
30+
<artifactId>spring-boot-starter-validation</artifactId>
31+
</dependency>
32+
<dependency>
33+
<groupId>io.swagger.core.v3</groupId>
34+
<artifactId>swagger-annotations</artifactId>
35+
<version>${swagger-annotations.version}</version>
36+
</dependency>
37+
<dependency>
38+
<groupId>org.openapitools</groupId>
39+
<artifactId>jackson-databind-nullable</artifactId>
40+
<version>${jackson-databind-nullable}</version>
41+
</dependency>
42+
<dependency>
43+
<groupId>com.github.kongchen</groupId>
44+
<artifactId>swagger-maven-plugin</artifactId>
45+
<version>${swagger-maven-plugin.version}</version>
46+
</dependency>
3347
<dependency>
3448
<groupId>jakarta.ws.rs</groupId>
3549
<artifactId>jakarta.ws.rs-api</artifactId>
@@ -44,40 +58,66 @@
4458
<artifactId>spring-boot-maven-plugin</artifactId>
4559
</plugin>
4660
<plugin>
47-
<groupId>com.github.kongchen</groupId>
48-
<artifactId>swagger-maven-plugin</artifactId>
49-
<version>${swagger-maven-plugin.version}</version>
50-
<configuration>
51-
<apiSources>
52-
<apiSource>
53-
<springmvc>false</springmvc>
54-
<locations>com.baeldung.swaggerenums.controller</locations>
55-
<schemes>http,https</schemes>
56-
<host>baeldung.com</host>
57-
<basePath>/api</basePath>
58-
<info>
59-
<title>Baeldung - Document Enum</title>
60-
<version>v1</version>
61-
<description>This is a Baeldung Document Enum Sample Code</description>
62-
<contact>
63-
<email>[email protected]</email>
64-
<name>Parikshit Murria</name>
65-
</contact>
66-
<license>
67-
<url>https://www.apache.org/licenses/LICENSE-2.0.html</url>
68-
<name>Apache 2.0</name>
69-
</license>
70-
</info>
71-
<swaggerDirectory>${basedir}/target/swagger-ui</swaggerDirectory>
72-
</apiSource>
73-
</apiSources>
74-
</configuration>
61+
<groupId>io.swagger.codegen.v3</groupId>
62+
<artifactId>swagger-codegen-maven-plugin</artifactId>
63+
<version>${swagger-codegen-maven-plugin.version}</version>
64+
<executions>
65+
<execution>
66+
<id>dates</id>
67+
<goals>
68+
<goal>generate</goal>
69+
</goals>
70+
<configuration>
71+
<inputSpec>${project.basedir}/src/main/resources/static/event.yaml</inputSpec>
72+
<language>spring</language>
73+
<configOptions>
74+
<java8>true</java8>
75+
<dateLibrary>custom</dateLibrary>
76+
<jakarta>true</jakarta>
77+
<useSpringBoot3>true</useSpringBoot3>
78+
</configOptions>
79+
<typeMappings>
80+
<typeMapping>DateTime=Instant</typeMapping>
81+
<typeMapping>Date=Date</typeMapping>
82+
</typeMappings>
83+
<importMappings>
84+
<importMapping>Instant=java.time.Instant</importMapping>
85+
<importMapping>Date=java.util.Date</importMapping>
86+
</importMappings>
87+
</configuration>
88+
</execution>
89+
</executions>
90+
</plugin>
91+
<plugin>
92+
<groupId>org.openapitools</groupId>
93+
<artifactId>openapi-generator-maven-plugin</artifactId>
94+
<version>${openapi-generator.version}</version>
7595
<executions>
7696
<execution>
77-
<phase>compile</phase>
7897
<goals>
7998
<goal>generate</goal>
8099
</goals>
100+
<configuration>
101+
<skipValidateSpec>true</skipValidateSpec>
102+
<inputSpec>${project.basedir}/src/main/resources/static/event.yaml</inputSpec>
103+
<generatorName>spring</generatorName>
104+
<configOptions>
105+
<java8>true</java8>
106+
<dateLibrary>custom</dateLibrary>
107+
<openApiNullable>false</openApiNullable>
108+
<interfaceOnly>true</interfaceOnly>
109+
<useSpringBoot3>true</useSpringBoot3>
110+
<useJakarta>true</useJakarta>
111+
</configOptions>
112+
<typeMappings>
113+
<typeMapping>DateTime=Instant</typeMapping>
114+
<typeMapping>Date=Date</typeMapping>
115+
</typeMappings>
116+
<importMappings>
117+
<importMapping>Instant=java.time.Instant</importMapping>
118+
<importMapping>Date=java.util.Date</importMapping>
119+
</importMappings>
120+
</configuration>
81121
</execution>
82122
</executions>
83123
</plugin>
@@ -88,6 +128,10 @@
88128
<swagger-maven-plugin.version>3.1.1</swagger-maven-plugin.version>
89129
<springdoc.version>1.7.0</springdoc.version>
90130
<jakarta.ws.rs-api.version>3.1.0</jakarta.ws.rs-api.version>
131+
<swagger-annotations.version>2.2.28</swagger-annotations.version>
132+
<swagger-codegen-maven-plugin.version>3.0.67</swagger-codegen-maven-plugin.version>
133+
<openapi-generator.version>7.11.0</openapi-generator.version>
134+
<jackson-databind-nullable>0.2.6</jackson-databind-nullable>
91135
<start-class>com.baeldung.swaggerexample.SwaggerExampleApplication</start-class>
92136
</properties>
93137

‎spring-boot-modules/spring-boot-swagger/src/main/java/com/baeldung/parametervsschema/SpringBootSwaggerApplication.java

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
package com.baeldung.parametervsschema;
2+
3+
import org.springframework.boot.SpringApplication;
4+
import org.springframework.boot.autoconfigure.SpringBootApplication;
5+
6+
@SpringBootApplication
7+
public class SpringBootSwaggerApplication {
8+
9+
public static void main(String[] args) {
10+
SpringApplication.run(SpringBootSwaggerApplication.class, args);
11+
}
12+
13+
}

0 commit comments

Comments
 (0)