SB-261 (Feat) : 통합 Swagger API 구현

FX-BAOBAB · Aug 18, 2024 · c49bb07 · c49bb07
1 parent 68caa54
commit c49bb07
Show file tree

Hide file tree

Showing 6 changed files with 61 additions and 3 deletions.
diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml
@@ -21,7 +21,7 @@ jobs:
       - name: Make docker-compose.yml
         run: echo "${{ secrets.DOCKER_COMPOSE }}" > docker-compose.yml
 
-      - name: Make Warehouse application.yml
+      - name: Make Gateway application.yml
         run: |
           cd ./gateway/src/main/resources
           echo "${{ secrets.GATEWAY_APPLICATION }}" > application.yml

diff --git a/delivery/src/main/java/delivery/DeliveryApplication.java b/delivery/src/main/java/delivery/DeliveryApplication.java
@@ -1,9 +1,11 @@
 package delivery;
 
+import io.swagger.v3.oas.annotations.OpenAPIDefinition;
+import io.swagger.v3.oas.annotations.servers.Server;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 
-//@OpenAPIDefinition(servers = {@Server(url = "https://baobab.run", description = "fx server 연습용 도메인")})
+@OpenAPIDefinition(servers = {@Server(url = "https://baobab.run/delivery/", description = "Baobab Dev Server API")})
 @SpringBootApplication
 public class DeliveryApplication {
 

diff --git a/delivery/src/main/java/delivery/common/config/web/WebConfig.java b/delivery/src/main/java/delivery/common/config/web/WebConfig.java
@@ -0,0 +1,37 @@
+package delivery.common.config.web;
+
+import io.swagger.v3.oas.models.Components;
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.security.SecurityRequirement;
+import io.swagger.v3.oas.models.security.SecurityScheme;
+import java.util.Collections;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
+
+@Configuration
+public class WebConfig implements WebMvcConfigurer {
+
+    @Value("${file.upload-dir}")
+    private String uploadDir;
+
+    @Bean
+    public OpenAPI swaggerAuthorization() {
+        SecurityScheme securityScheme = new SecurityScheme()
+            .type(SecurityScheme.Type.HTTP).scheme("bearer").bearerFormat("JWT")
+            .in(SecurityScheme.In.HEADER).name("Authorization");
+        SecurityRequirement securityRequirement = new SecurityRequirement().addList("bearerAuth");
+
+        return new OpenAPI()
+            .components(new Components().addSecuritySchemes("bearerAuth", securityScheme))
+            .security(Collections.singletonList(securityRequirement));
+    }
+
+    @Override
+    public void addResourceHandlers(ResourceHandlerRegistry registry) {
+        registry.addResourceHandler("/images/**")
+            .addResourceLocations("file:" + uploadDir);
+    }
+}
diff --git a/gateway/build.gradle b/gateway/build.gradle
@@ -23,6 +23,8 @@ ext {
 
 dependencies {
 	implementation 'org.springframework.cloud:spring-cloud-starter-gateway'
+	implementation 'org.springdoc:springdoc-openapi-starter-webflux-ui:2.0.2'
+	implementation 'org.springdoc:springdoc-openapi-ui:1.7.0'
 	testImplementation 'org.springframework.boot:spring-boot-starter-test'
 	testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
 }

diff --git a/warehouse/src/main/java/warehouse/WarehouseApplication.java b/warehouse/src/main/java/warehouse/WarehouseApplication.java
@@ -7,7 +7,7 @@
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import warehouse.domain.image.properties.FileStorageProperties;
 
-@OpenAPIDefinition(servers = {@Server(url = "https://baobab.run", description = "fx server 연습용 도메인")})
+@OpenAPIDefinition(servers = {@Server(url = "https://baobab.run/warehouse/", description = "Baobab Dev Server API")})
 @SpringBootApplication
 @EnableConfigurationProperties({
     FileStorageProperties.class

diff --git a/warehouse/src/main/java/warehouse/common/config/web/WebConfig.java b/warehouse/src/main/java/warehouse/common/config/web/WebConfig.java
@@ -1,5 +1,10 @@
 package warehouse.common.config.web;
 
+import io.swagger.v3.oas.models.Components;
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.security.SecurityRequirement;
+import io.swagger.v3.oas.models.security.SecurityScheme;
+import java.util.Collections;
 import java.util.List;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.annotation.Bean;
@@ -30,6 +35,18 @@ CorsConfigurationSource corsConfigurationSource() {
         return source;
     }
 
+    @Bean
+    public OpenAPI swaggerAuthorization() {
+        SecurityScheme securityScheme = new SecurityScheme()
+            .type(SecurityScheme.Type.HTTP).scheme("bearer").bearerFormat("JWT")
+            .in(SecurityScheme.In.HEADER).name("Authorization");
+        SecurityRequirement securityRequirement = new SecurityRequirement().addList("bearerAuth");
+
+        return new OpenAPI()
+            .components(new Components().addSecuritySchemes("bearerAuth", securityScheme))
+            .security(Collections.singletonList(securityRequirement));
+    }
+
     @Override
     public void addResourceHandlers(ResourceHandlerRegistry registry) {
         registry.addResourceHandler("/images/**")