CSSTUDIO-2026: add openapi/swagger. fix: upgrade maven-javadoc-plugin…

… for MJAVADOC-650
Olog · Jan 3, 2024 · 9daa470 · 9daa470
1 parent c87bfff
commit 9daa470
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/pom.xml b/pom.xml
@@ -56,6 +56,7 @@
         <elasticsearch.version>8.2.0</elasticsearch.version>
         <lombok.version>1.18.16</lombok.version>
         <junit.version>5.8.2</junit.version>
+        <springdoc.version>1.6.10</springdoc.version>
         <skipITs>true</skipITs>
         <skipITCoverage>true</skipITCoverage>
         <jacoco.skip>true</jacoco.skip>
@@ -113,6 +114,18 @@
             <version>2.0.1</version>
         </dependency>
 
+        <!-- OpenAPI / Swagger UI -->
+        <dependency>
+            <groupId>org.springdoc</groupId>
+            <artifactId>springdoc-openapi-ui</artifactId>
+            <version>${springdoc.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.springdoc</groupId>
+            <artifactId>springdoc-openapi-security</artifactId>
+            <version>${springdoc.version}</version>
+        </dependency>
+
         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-test</artifactId>
@@ -363,7 +376,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
-                <version>3.1.1</version>
+                <version>3.3.0</version>
                 <executions>
                     <execution>
                         <id>attach-javadocs</id>

diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties
@@ -183,3 +183,10 @@ default.logbook.url=
 default.tags.url=
 default.properties.url=
 
+########### OpenAPI / Swagger #############
+#OPENAPI
+openapi.server=${OPENAPI_SERVER:http://localhost:8080}
+springdoc.api-docs.path=${API_PATH:/api/spec}
+springdoc.swagger-ui.path=${SWAGGER_PATH:/api/docs}
+springdoc.swagger-ui.disable-swagger-default-url=true
+springdoc.swagger-ui.displayOperationId=true