feat #8: Swagger 추가 및 설정

6QuizOnTheBlock · Apr 25, 2024 · 4ee7b49 · 4ee7b49
1 parent 417f951
commit 4ee7b49
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 2 deletions.
diff --git a/backEnd/build.gradle b/backEnd/build.gradle
@@ -41,6 +41,7 @@ dependencies {
     annotationProcessor 'org.projectlombok:lombok'
     testImplementation 'org.springframework.boot:spring-boot-starter-test'
     runtimeOnly 'com.mysql:mysql-connector-j'
+    implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.2.0'
 }
 
 tasks.named('test') {

diff --git a/backEnd/src/main/java/com/quiz/ourClass/global/config/SwaggerConfig.java b/backEnd/src/main/java/com/quiz/ourClass/global/config/SwaggerConfig.java
@@ -0,0 +1,41 @@
+package com.quiz.ourClass.global.config;
+
+import io.swagger.v3.oas.models.Components;
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Info;
+import io.swagger.v3.oas.models.security.SecurityRequirement;
+import io.swagger.v3.oas.models.security.SecurityScheme;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.http.HttpHeaders;
+
+@Configuration
+public class SwaggerConfig {
+
+    @Bean
+    public OpenAPI openAPI() {
+        Info info = new Info()
+            .title("울반 - OurClass API문서")
+            .version("v0.0.1")
+            .description("OurClass API 명세서.");
+
+        SecurityScheme bearer = new SecurityScheme()
+            .type(SecurityScheme.Type.HTTP)
+            .scheme("bearer")
+            .bearerFormat("Authorization")
+            .in(SecurityScheme.In.HEADER)
+            .name(HttpHeaders.AUTHORIZATION);
+
+        // Security 요청 설정
+        SecurityRequirement addSecurityItem = new SecurityRequirement();
+        addSecurityItem.addList("Authorization");
+
+        Components components = new Components()
+            .addSecuritySchemes("Authorization", bearer);
+
+        return new OpenAPI()
+            .components(components)
+            .addSecurityItem(addSecurityItem)
+            .info(info);
+    }
+}
diff --git a/backEnd/src/main/resources/application.yml b/backEnd/src/main/resources/application.yml
@@ -6,7 +6,6 @@ server:
       enabled: true
       force: true
     context-path: /api
----
 spring:
   profiles:
     group:
@@ -16,4 +15,15 @@ spring:
         - db-prod
     include:
       - key
-      - db
+      - db
+#springdoc swagger
+springdoc:
+  api-docs:
+    enabled: true
+    path: /swagger-ui/docs
+  swagger-ui:
+    enabled: true
+    path: /swagger-ui.html
+    tags-sorter: alpha            # alpha: 알파벳 순 태그 정렬, method: HTTP Method 순 정렬
+    operations-sorter: alpha      # alpha: 알파벳 순 태그 정렬, method: HTTP Method 순 정렬
+    display-request-duration: true