Merge pull request #205 from prgrms-be-devcourse/feat/204-swagger추가

[feat] swagger추가

Author: MADUPAL

build.gradle.kts

@@ -130,7 +130,7 @@ dependencies {
     testImplementation("org.testcontainers:testcontainers")
     testImplementation("org.springframework.boot:spring-boot-testcontainers")
 
-    implementation("org.springdoc:springdoc-openapi-starter-webmvc-ui:2.5.0")
+    implementation("org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.6")
 }
 
 tasks.withType<Test> {

src/main/java/com/back/global/config/SwaggerConfig.java

@@ -0,0 +1,25 @@
+package com.back.global.config;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import io.swagger.v3.oas.annotations.enums.SecuritySchemeType;
+import io.swagger.v3.oas.annotations.security.SecurityScheme;
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Info;
+import io.swagger.v3.oas.models.security.SecurityRequirement;
+
+@Configuration
+@SecurityScheme(name = "bearerAuth", type = SecuritySchemeType.HTTP, scheme = "bearer", bearerFormat = "JWT")
+public class SwaggerConfig {
+
+    @Bean
+    public OpenAPI openAPI() {
+        return new OpenAPI()
+                .info(new Info()
+                        .title("The Bracket API")
+                        .description("The Bracket 백엔드 API 문서")
+                        .version("v1"))
+                .addSecurityItem(new SecurityRequirement().addList("bearerAuth"));
+    }
+}

src/main/java/com/back/global/security/SecurityConfig.java

@@ -54,7 +54,11 @@ public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
                                 "/actuator/metrics",
                                 "/actuator/metrics/**",
                                 "/actuator/prometheus",
-                                "/error")
+                                "/error",
+                                // Swagger UI
+                                "/swagger-ui/**",
+                                "/swagger-ui.html",
+                                "/v3/api-docs/**")
                         .permitAll()
                         // 관리자 API는 ROLE_ADMIN만 접근 허용
                         .requestMatchers("/api/v1/admin/**")