📝 docs : API 문서 통합

WaitherTeam · May 9, 2024 · 8bdd018 · 8bdd018
1 parent c80d2ad
commit 8bdd018
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 3 deletions.
diff --git a/noti-service/build.gradle b/noti-service/build.gradle
@@ -2,6 +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'
 }
 
 group = 'com.waither'
@@ -48,14 +49,26 @@ dependencies {
     //Redis
     implementation 'org.springframework.boot:spring-boot-starter-data-redis'
 
-    //Swagger
+    //Springdoc
     implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.1.0'
+    //implementation 'org.springdoc:springdoc-openapi-gradle-plugin:1.8.0'
 
     //JUnit + AssertJ
     testImplementation 'org.junit.jupiter:junit-jupiter:5.8.2'
     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")
+    }
+}
+
 dependencyManagement {
     imports {
         mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}"

diff --git a/noti-service/src/main/resources/bootstrap.yml b/noti-service/src/main/resources/bootstrap.yml
@@ -9,7 +9,7 @@ spring:
   cloud:
     config:
       uri: http://localhost:8888
-      name: database-noti,redis
+      name: database-noti,redis,apiDocs-noti
   kafka:
     bootstrap-servers: "localhost:9092"
 
@@ -19,4 +19,4 @@ eureka:
     register-with-eureka: true # register to eureka server
     fetch-registry: true # Getting instances' information from eureka server
     service-url:
-      defaultZone : http://127.0.0.1:8761/eureka #Eureka Server's address
+      defaultZone : http://127.0.0.1:8761/eureka #Eureka Server's address