swagger dependecy를 제거하고 open api로 변경한다

tag-wonder · Nov 12, 2023 · 86ea65b · 86ea65b
1 parent dc4f718
commit 86ea65b
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 53 deletions.
diff --git a/api/build.gradle.kts b/api/build.gradle.kts
@@ -18,8 +18,7 @@ project(":api") {
         implementation("io.jsonwebtoken:jjwt-jackson:0.11.5")
         implementation("org.springframework.boot:spring-boot-starter-data-jpa")
 
-        implementation("io.springfox:springfox-swagger-ui:3.0.0")
-        implementation("io.springfox:springfox-boot-starter:3.0.0")
+        implementation("org.springdoc:springdoc-openapi-starter-webmvc-ui:2.2.0")
 
         implementation("org.jetbrains.kotlin:kotlin-reflect")
 

diff --git a/api/src/main/kotlin/org/tagwonder/configs/OpenApiConfig.kt b/api/src/main/kotlin/org/tagwonder/configs/OpenApiConfig.kt
@@ -0,0 +1,19 @@
+package org.tagwonder.configs
+
+import io.swagger.v3.oas.models.OpenAPI
+import io.swagger.v3.oas.models.info.Info
+import org.springframework.context.annotation.Bean
+import org.springframework.context.annotation.Configuration
+
+
+@Configuration
+open class OpenApiConfig {
+    @Bean
+    open fun openAPI(): OpenAPI {
+        val info: Info = Info()
+            .version("v1.0.0")
+            .title("Tag Wonder Api Document")
+        return OpenAPI()
+            .info(info)
+    }
+}
diff --git a/api/src/main/kotlin/org/tagwonder/configs/SwaggerConfig.kt b/api/src/main/kotlin/org/tagwonder/configs/SwaggerConfig.kt
diff --git a/api/src/main/kotlin/org/tagwonder/controllers/MemberController.kt b/api/src/main/kotlin/org/tagwonder/controllers/MemberController.kt
@@ -1,7 +1,6 @@
 package org.tagwonder.controllers
 
-import io.swagger.annotations.ApiImplicitParam
-import io.swagger.annotations.ApiOperation
+import io.swagger.v3.oas.annotations.Operation
 import org.springframework.http.ResponseEntity
 import org.springframework.web.bind.annotation.PostMapping
 import org.springframework.web.bind.annotation.RequestBody
@@ -14,9 +13,7 @@ import org.tagwonder.usecases.commands.SignInOAuthCommandExecutor
 class MemberController(
     private val signInOAuthCommandExecutor: SignInOAuthCommandExecutor
 ) {
-
-    @ApiOperation(value = "카카오 로그인", notes = "로그인 요청 후 있으면 로그인, 없으면 회원가입합니다.")
-    @ApiImplicitParam(name = "command", value = "카카오 인가(authorization) 코드")
+    @Operation(summary = "카카오 로그인", description = "로그인 요청 후 있으면 로그인, 없으면 회원가입합니다.")
     @PostMapping("/sign-in/kakao")
     fun signInKakao(
         @RequestBody command: SignInKakaoOauth

diff --git a/api/src/main/kotlin/org/tagwonder/controllers/TagController.kt b/api/src/main/kotlin/org/tagwonder/controllers/TagController.kt
@@ -1,6 +1,6 @@
 package org.tagwonder.controllers
 
-import io.swagger.annotations.ApiOperation
+import io.swagger.v3.oas.annotations.Operation
 import org.springframework.http.HttpStatus
 import org.springframework.web.bind.annotation.*
 import org.tagwonder.commands.CreateTagsApiCommand
@@ -20,7 +20,7 @@ class TagController(
     private val authTokenGenerator: AuthTokenGenerator
 ) {
 
-    @ApiOperation(value = "태그 복수 생성")
+    @Operation(summary = "태그 복수 생성")
     @PostMapping("/tags")
     fun createTags(
         @RequestHeader(value = "Authorization", required = true) authToken: String,
@@ -38,7 +38,7 @@ class TagController(
         }
     }
 
-    @ApiOperation(value = "태그 전체 조회")
+    @Operation(summary = "태그 전체 조회")
     @GetMapping("/tags")
     fun getTags(
         @RequestHeader(value = "Authorization", required = true) authToken: String