[feat] SpringDoc 설정 (#13)

* chore: Update README.md (#2)

* feat: SpringDoc 설정

Author: dbfgml2000

back/build.gradle.kts

@@ -33,6 +33,9 @@ dependencies {
 	implementation("org.springframework.boot:spring-boot-starter-data-jpa")
 	implementation("org.springframework.boot:spring-boot-starter-security")
 	implementation("org.springframework.boot:spring-boot-starter-web")
+
+	implementation("org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.13")
+
 	compileOnly("org.projectlombok:lombok")
 	developmentOnly("org.springframework.boot:spring-boot-devtools")
 	runtimeOnly("com.h2database:h2")

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

@@ -48,7 +48,10 @@ protected void doFilterInternal(HttpServletRequest request, HttpServletResponse
     private void work(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
         // 인증이 필요없는 API 요청이라면 패스
         if (List.of("/auth/login", "/auth/signup", "/h2-console").contains(request.getRequestURI()) ||
-                request.getRequestURI().startsWith("/h2-console/")) {
+                request.getRequestURI().startsWith("/h2-console/") ||
+                request.getRequestURI().startsWith("/swagger-ui/") ||
+                request.getRequestURI().startsWith("/v3/api-docs/") ||
+                request.getRequestURI().startsWith("/swagger-resources/")) {
             filterChain.doFilter(request, response);
             return;
         }

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

@@ -27,6 +27,7 @@ public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
                         .requestMatchers("/h2-console/**").permitAll()
                         .requestMatchers("/auth/**").permitAll()
                         .requestMatchers("/actuator/**").permitAll()
+                        .requestMatchers("/swagger-ui/**", "/v3/api-docs/**", "/swagger-resources/**").permitAll()
                         .anyRequest().authenticated()
                 )
                 .headers(headers -> headers

back/src/main/java/com/back/global/springdoc/SpringDocConfig.java

@@ -0,0 +1,19 @@
+package com.back.global.springdoc;
+
+import io.swagger.v3.oas.annotations.OpenAPIDefinition;
+import io.swagger.v3.oas.annotations.enums.SecuritySchemeIn;
+import io.swagger.v3.oas.annotations.enums.SecuritySchemeType;
+import io.swagger.v3.oas.annotations.info.Info;
+import io.swagger.v3.oas.annotations.security.SecurityScheme;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+@OpenAPIDefinition(info = @Info(title = "API 서버", version = "beta", description = "API 서버 문서입니다."))
+@SecurityScheme(
+        name = "cookieAuth",
+        type = SecuritySchemeType.APIKEY,
+        in = SecuritySchemeIn.COOKIE,
+        paramName = "accessToken"
+)
+public class SpringDocConfig {
+}

back/src/main/resources/application.yml

@@ -1,6 +1,7 @@
 server:
   port: 8080
   forward-headers-strategy: native
+
 spring:
   application:
     name: back
@@ -32,12 +33,13 @@ spring:
         use_sql_comments: true
         default_batch_fetch_size: 100
     open-in-view: false
+
 springdoc: #Swagger ??
   default-produces-media-type: application/json;charset=UTF-8
   swagger-ui:
     path: /swagger-ui.html
   api-docs:
-    path: /api-docs
+    path: /v3/api-docs
 logging:
   level:
     org.hibernate.orm.jdbc.bind: TRACE