📝 docs: Swagger 적용 (#77)

WaitherTeam · May 27, 2024 · b271744 · b271744
2 parents f46c052 + 37d7a5d
commit b271744
Show file tree

Hide file tree

Showing 7 changed files with 71 additions and 20 deletions.
diff --git a/apiGateway-service/Dockerfile b/apiGateway-service/Dockerfile
@@ -2,4 +2,5 @@ FROM openjdk:17-jdk
 
 ARG JAR_FILE=build/libs/*.jar
 COPY ${JAR_FILE} app.jar
+COPY src/main/resources/static /app/static
 ENTRYPOINT ["java", "-Dspring.profiles.active=prod", "-Duser.timezone=Asia/Seoul" , "-jar", "app.jar"]
diff --git a/apiGateway-service/build.gradle b/apiGateway-service/build.gradle
@@ -56,6 +56,8 @@ dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-security'
     testImplementation 'org.springframework.security:spring-security-test'
 
+    // Swagger
+    implementation 'org.springdoc:springdoc-openapi-starter-webflux-ui:2.1.0'
 
 //    //Spring Boot Actuator
 //    implementation 'org.springframework.boot:spring-boot-starter-actuator'

diff --git a/apiGateway-service/src/main/resources/bootstrap.yml b/apiGateway-service/src/main/resources/bootstrap.yml
@@ -1,5 +1,5 @@
 server:
-  port: 80
+  port: 443
 
 spring:
   application:
@@ -22,8 +22,28 @@ eureka:
     service-url:
       defaultZone: http://localhost:8761/eureka
 
+
+springdoc:
+#  api-docs:
+#    enabled: true
+#    version: openapi_3_0
+  swagger-ui:
+    use-root-path: true
+    urls:
+      - url: /noti/v3/api-docs
+        name: Notification Service
+      - url: /weather/v3/api-docs
+        name: Weather Service
+      - url: /user/v3/api-docs
+        name: User Service
+#    path: /swagger-ui.html
+#    version: 3.0.0
+
+
+
 #management: # Actuator Settings
 #  endpoints:
 #    web:
 #      exposure:
-#        include: refresh, health, beans, httptrace
+#        include: refresh, health, beans, httptrace
+
diff --git a/noti-service/build.gradle b/noti-service/build.gradle
@@ -2,7 +2,7 @@ plugins {
     id 'java'
     id 'org.springframework.boot' version '3.2.3'
     id 'io.spring.dependency-management' version '1.1.4'
-    id "org.springdoc.openapi-gradle-plugin" version '1.8.0'
+//    id "org.springdoc.openapi-gradle-plugin" version '1.8.0'
 }
 
 group = 'com.waither'
@@ -62,16 +62,16 @@ dependencies {
     testImplementation 'org.assertj:assertj-core:3.23.1'
 }
 
-openApi {
-    apiDocsUrl.set("http://localhost:80") // Document URL
-    outputDir.set(file("$rootDir/build/docs")) // Build Result Path
-    outputFileName.set("noti.json") // Build Result File Name
-    groupedApiMappings.set(Map.of("http://localhost:8082/noti/api-docs", "noti.json"))
-    waitTimeInSeconds.set(60) // Timeout
-    customBootRun {
-        args.add("--spring.profiles.active=dev")
-    }
-}
+//openApi {
+//    apiDocsUrl.set("http://localhost:80") // Document URL
+//    outputDir.set(file("$rootDir/build/docs")) // Build Result Path
+//    outputFileName.set("noti.json") // Build Result File Name
+//    groupedApiMappings.set(Map.of("http://localhost:8082/noti/api-docs", "noti.json"))
+//    waitTimeInSeconds.set(60) // Timeout
+//    customBootRun {
+//        args.add("--spring.profiles.active=dev")
+//    }
+//}
 
 dependencyManagement {
     imports {

diff --git a/noti-service/src/main/resources/bootstrap.yml b/noti-service/src/main/resources/bootstrap.yml
@@ -19,4 +19,14 @@ eureka:
     register-with-eureka: true # register to eureka server
     fetch-registry: true # Getting instances' information from eureka server
     service-url:
-      defaultZone : http://localhost:8761/eureka #Eureka Server's address
+      defaultZone : http://127.0.0.1:8761/eureka #Eureka Server's address
+
+springdoc:
+  api-docs:
+    version: openapi_3_0
+    enabled: true
+    path: /noti/v3/api-docs
+  default-consumes-media-type: application/json
+  default-produces-media-type: application/json
+  enable-spring-security: true
+
diff --git a/user-service/src/main/resources/bootstrap.yml b/user-service/src/main/resources/bootstrap.yml
@@ -27,4 +27,13 @@ eureka:
 #  endpoints:
 #    web:
 #      exposure:
-#        include: busrefresh
+#        include: busrefresh
+
+springdoc:
+  api-docs:
+    version: openapi_3_0
+    enabled: true
+    path: /user/v3/api-docs
+  default-consumes-media-type: application/json
+  default-produces-media-type: application/json
+  enable-spring-security: true
diff --git a/weather-service/src/main/resources/bootstrap.yml b/weather-service/src/main/resources/bootstrap.yml
@@ -23,8 +23,17 @@ eureka:
     service-url:
       defaultZone : http://localhost:8761/eureka #Eureka Server's address
 
-management: # Actuator
-  endpoints:
-    web:
-      exposure:
-        include: busrefresh
+#management: # Actuator
+#  endpoints:
+#    web:
+#      exposure:
+#        include: busrefresh
+
+springdoc:
+  api-docs:
+    version: openapi_3_0
+    enabled: true
+    path: /noti/v3/api-docs
+  default-consumes-media-type: application/json
+  default-produces-media-type: application/json
+  enable-spring-security: true