feat: Swagger setting hoho

gradle.properties

@@ -1,2 +1,3 @@
 jjwtVersion=0.11.5
 mysqlConnectorVersion=8.0.33
+springDocOpenApiVersion=2.0.2

pic-api/build.gradle.kts

@@ -11,6 +11,7 @@ tasks.jar {
 apply(plugin = "com.google.cloud.tools.jib")
 
 val jjwtVersion: String by project.extra
+val springDocOpenApiVersion: String by project.extra
 
 dependencies {
     implementation(project(":pic-common"))
@@ -32,6 +33,9 @@ dependencies {
     implementation("com.fasterxml.jackson.module:jackson-module-kotlin")
     developmentOnly("org.springframework.boot:spring-boot-devtools")
     testImplementation("org.springframework.boot:spring-boot-starter-test")
+
+    // swagger
+    implementation("org.springdoc:springdoc-openapi-starter-webmvc-ui:$springDocOpenApiVersion")
 }
 
 configure<JibExtension> {

pic-api/src/main/kotlin/com/mashup/pic/auth/controller/AuthController.kt

@@ -8,19 +8,22 @@ import com.mashup.pic.auth.applicationService.AuthApplicationService
 import com.mashup.pic.auth.controller.dto.LoginRequest
 import com.mashup.pic.auth.controller.dto.LoginResponse
 import com.mashup.pic.common.ApiResponse
+import io.swagger.v3.oas.annotations.Operation
+import io.swagger.v3.oas.annotations.tags.Tag
 import jakarta.validation.Valid
 
+@Tag(name = "인증 컨트롤러")
 @RestController
 @RequestMapping("/api/v1/auth")
 class AuthController(
         private val authApplicationService: AuthApplicationService,
 ) {
 
+    @Operation(summary = "로그인")
     @PostMapping("/login")
     fun login(
             @Valid @RequestBody loginRequest: LoginRequest
     ): ApiResponse<LoginResponse> {
         return ApiResponse.success(authApplicationService.login(loginRequest.toServiceRequest()))
     }
-
 }

pic-api/src/main/kotlin/com/mashup/pic/config/SecurityConfig.kt

@@ -46,7 +46,10 @@ class SecurityConfig(
         private const val MEMBER_ROLE = "MEMBER"
         private val WHITELIST_ENDPOINTS = arrayOf(
                 "/api/v1/auth/login",
-                "/api/v1/auth/token"
+                "/api/v1/auth/token",
+                "/health",
+                "/swagger-ui/**",
+                "/v3/api-docs/**"
         )
     }
 

pic-api/src/main/kotlin/com/mashup/pic/config/SwaggerConfig.kt

@@ -0,0 +1,59 @@
+package com.mashup.pic.config
+
+import com.mashup.pic.constant.ROOT_PACKAGE
+import io.swagger.v3.oas.annotations.OpenAPIDefinition
+import io.swagger.v3.oas.annotations.info.Info
+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 io.swagger.v3.oas.models.servers.Server
+import org.springdoc.core.models.GroupedOpenApi
+import org.springframework.beans.factory.annotation.Value
+import org.springframework.context.annotation.Bean
+import org.springframework.context.annotation.Configuration
+
+@Configuration
+@OpenAPIDefinition(
+    info = Info(
+        title = "pic API",
+        description = "pic API api documents",
+        version = "v0"
+    )
+)
+class SwaggerConfig(
+    @Value("\${swagger.host.url:http://localhost:8080}")
+    val serverHostUrl: String
+) {
+
+    @Bean
+    fun openApi(): OpenAPI {
+        val schemeName = "Authorization"
+        val securityRequirement = SecurityRequirement()
+            .addList(schemeName)
+        val components = Components()
+            .addSecuritySchemes(
+                schemeName,
+                SecurityScheme()
+                    .name(schemeName)
+                    .type(SecurityScheme.Type.HTTP)
+                    .`in`(SecurityScheme.In.HEADER)
+                    .scheme("bearer")
+                    .bearerFormat("JWT")
+            )
+
+        return OpenAPI()
+            .addServersItem(Server().url(serverHostUrl))
+            .addSecurityItem(securityRequirement)
+            .components(components)
+    }
+
+    @Bean
+    fun server(): GroupedOpenApi {
+        return GroupedOpenApi.builder()
+            .group("pic-api")
+            .pathsToExclude("/health")
+            .packagesToScan(ROOT_PACKAGE)
+            .build()
+    }
+}

pic-api/src/main/kotlin/com/mashup/pic/health/HealthCheckController.kt

@@ -0,0 +1,12 @@
+package com.mashup.pic.health
+
+import org.springframework.web.bind.annotation.GetMapping
+import org.springframework.web.bind.annotation.RestController
+
+@RestController
+class HealthCheckController {
+    @GetMapping("/health")
+    fun healthCheck(): String {
+        return "ok"
+    }
+}

pic-common/src/main/kotlin/com/mashup/pic/constant/Constant.kt

@@ -0,0 +1,3 @@
+package com.mashup.pic.constant
+
+const val ROOT_PACKAGE = "com.mashup.pic"