Feature/14 set swagger

buildSrc/src/main/kotlin/Dependencies.kt

@@ -43,4 +43,7 @@ object Dependencies {
 
     // Spring Cloud Config
     const val SPRING_CLOUD_CONFIG = "org.springframework.cloud:spring-cloud-starter-config"
+
+    // swagger
+    const val SWAGGER = "org.springdoc:springdoc-openapi-starter-webmvc-ui:${DependencyVersion.SWAGGER_VERSION}"
 }

buildSrc/src/main/kotlin/DependencyVersion.kt

@@ -16,4 +16,5 @@ object DependencyVersion {
     const val GOOGLE_PROTOBUF = "3.25.3"
 
     const val SPRING_CLOUD_CONFIG_VERSION = "2023.0.3"
+    const val SWAGGER_VERSION = "2.5.0"
 }

casper-schedule/build.gradle.kts

@@ -75,6 +75,9 @@ dependencies {
 
 	// Cloud Config
 	implementation(Dependencies.SPRING_CLOUD_CONFIG)
+
+	// Swagger
+	implementation(Dependencies.SWAGGER)
 }
 
 

casper-schedule/src/main/kotlin/hs/kr/entrydsm/schedule/domain/schedule/adapter/in/ScheduleWebAdapter.kt

@@ -6,6 +6,7 @@ import hs.kr.entrydsm.schedule.domain.schedule.adapter.`in`.dto.response.Schedul
 import hs.kr.entrydsm.schedule.domain.schedule.application.port.`in`.QueryScheduleByTypeUseCase
 import hs.kr.entrydsm.schedule.domain.schedule.application.port.`in`.QuerySchedulesUseCase
 import hs.kr.entrydsm.schedule.domain.schedule.application.port.`in`.UpdateSchedulesUseCase
+import hs.kr.entrydsm.schedule.global.document.schedule.ScheduleApiDocument
 import jakarta.validation.Valid
 import org.springframework.web.bind.annotation.GetMapping
 import org.springframework.web.bind.annotation.PatchMapping
@@ -28,9 +29,9 @@ class ScheduleWebAdapter(
     private val queryScheduleByTypeUseCase: QueryScheduleByTypeUseCase,
     private val querySchedulesUseCase: QuerySchedulesUseCase,
     private val updateSchedulesUseCase: UpdateSchedulesUseCase
-) {
+) : ScheduleApiDocument {
     @GetMapping(params = ["type"])
-    fun queryScheduleByType(
+    override fun queryScheduleByType(
         @RequestParam type: String
     ): ScheduleDto = queryScheduleByTypeUseCase.execute(type)
 
@@ -40,7 +41,7 @@ class ScheduleWebAdapter(
      * @return 모든 일정 정보를 담은 응답 객체
      */
     @GetMapping
-    fun querySchedules(): SchedulesResponse = querySchedulesUseCase.execute()
+    override fun querySchedules(): SchedulesResponse = querySchedulesUseCase.execute()
 
     /**
      * 일정을 일괄 업데이트합니다.
@@ -49,7 +50,7 @@ class ScheduleWebAdapter(
      * @return 업데이트된 일정 정보를 담은 응답 객체
      */
     @PatchMapping
-    fun updateSchedules(
+    override fun updateSchedules(
         @RequestBody @Valid
         request: UpdateSchedulesRequest
     ) = updateSchedulesUseCase.execute(request)

casper-schedule/src/main/kotlin/hs/kr/entrydsm/schedule/global/document/schedule/ScheduleApiDocument.kt

@@ -0,0 +1,71 @@
+package hs.kr.entrydsm.schedule.global.document.schedule
+
+import hs.kr.entrydsm.schedule.domain.schedule.adapter.`in`.dto.ScheduleDto
+import hs.kr.entrydsm.schedule.domain.schedule.adapter.`in`.dto.request.UpdateSchedulesRequest
+import hs.kr.entrydsm.schedule.domain.schedule.adapter.`in`.dto.response.SchedulesResponse
+import io.swagger.v3.oas.annotations.Operation
+import io.swagger.v3.oas.annotations.media.Content
+import io.swagger.v3.oas.annotations.responses.ApiResponse
+import io.swagger.v3.oas.annotations.responses.ApiResponses
+import io.swagger.v3.oas.annotations.tags.Tag
+import jakarta.validation.Valid
+import org.springframework.web.bind.annotation.RequestBody
+import org.springframework.web.bind.annotation.RequestParam
+
+@Tag(name = "Schedule", description = "전형 일정 API")
+interface ScheduleApiDocument {
+
+    @Operation(
+        summary = "일정 종류별 전형 일정 조회",
+        description = "일정 종류별 전형 일정을 조회합니다."
+    )
+    @ApiResponses(
+        ApiResponse(
+            responseCode = "200",
+            description = "일정 종류별 전형 일정 조회 성공",
+            content = arrayOf(Content())
+        ),
+        ApiResponse(
+            responseCode = "404",
+            description = "일정 종류에 알맞는 일정을 찾을 수 없습니다. - Schedule Not Found",
+            content = arrayOf(Content())
+        )
+    )
+    fun queryScheduleByType(
+        @RequestParam type: String
+    ): ScheduleDto
+
+    @Operation(
+        summary = "모든 전형 일정 조회",
+        description = "모든 전형 일정을 조회합니다."
+    )
+    @ApiResponses(
+        ApiResponse(
+            responseCode = "200",
+            description = "모든 전형 일정 조회 성공",
+            content = arrayOf(Content())
+        )
+    )
+    fun querySchedules(): SchedulesResponse
+
+    @Operation(
+        summary = "일전형 일정 수정",
+        description = "전형 일정을 수정합니다."
+    )
+    @ApiResponses(
+        ApiResponse(
+            responseCode = "200",
+            description = "일전형 일정 수정 성공",
+            content = arrayOf(Content())
+        ),
+        ApiResponse(
+            responseCode = "404",
+            description = "일정 종류에 알맞는 일정을 찾을 수 없습니다. - Schedule Not Found",
+            content = arrayOf(Content())
+        )
+    )
+    fun updateSchedules(
+        @RequestBody @Valid
+        request: UpdateSchedulesRequest
+    )
+}