API Docs를 수정한다. (#55)

* fix

* fix: doFirst

* fix: remove gradle properties

Author: char-yb

api/build.gradle.kts

@@ -1,4 +1,6 @@
 import com.epages.restdocs.apispec.gradle.OpenApi3Task
+import groovy.lang.Closure
+import io.swagger.v3.oas.models.servers.Server
 
 plugins {
     alias(libs.plugins.restdocs.api.spec)
@@ -47,17 +49,36 @@ tasks {
         finalizedBy(withType<OpenApi3Task>())
     }
 
+    withType<OpenApi3Task> {
+        doFirst {
+            val outputDir = file("src/main/resources/static/docs")
+            if (!outputDir.exists()) {
+                outputDir.mkdirs()
+            }
+        }
+    }
+
     jib {
         from {
             image = "amazoncorretto:21-alpine"
         }
     }
+}
 
-    openapi3 {
-        title = "Gotchai API"
-        version = "v1"
-        format = "yml"
-        outputFileNamePrefix = "api"
-        outputDirectory = "src/main/resources/static/docs"
-    }
+openapi3 {
+    title = "Gotchai API"
+    version = "v1"
+    format = "yml"
+    outputFileNamePrefix = "api"
+    outputDirectory = "src/main/resources/static/docs"
+    setServers(
+        listOf(
+            "https://dev-api.gotchai-ai.com",
+            "http://localhost:8080",
+        ).map { url ->
+            object : Closure<Server>(this) {
+                fun doCall(): Server = Server().apply { this.url = url }
+            }
+        },
+    )
 }

api/src/test/kotlin/com/gotchai/api/presentation/v1/exam/ExamControllerTest.kt

@@ -18,6 +18,7 @@ import com.gotchai.domain.global.exception.NotFoundDataException
 import com.ninjasquad.springmockk.MockkBean
 import io.mockk.every
 import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest
+import org.springframework.restdocs.payload.PayloadDocumentation.responseBody
 import org.springframework.test.web.reactive.server.expectBody
 
 @WebMvcTest(ExamController::class)
@@ -49,6 +50,20 @@ class ExamControllerTest : ControllerTest() {
                         }
                 }
             }
+
+            context("시험 목록이 비어있는 경우") {
+                every { examQueryUseCase.getExams() } returns emptyList()
+
+                it("상태 코드 200과 빈 리스트를 반환한다.") {
+                    webClient
+                        .get()
+                        .uri("/api/v1/exams")
+                        .exchange()
+                        .expectStatus()
+                        .isOk
+                        .expectBody<ApiResponse<ExamListResponse>>()
+                }
+            }
         }
 
         describe("getExamById()는") {

api/src/testFixtures/kotlin/com/gotchai/api/docs/CommonDocs.kt

@@ -9,6 +9,7 @@ val apiResponseFields =
     fieldsOf(
         ApiResponse<*>::isSuccess bodyDesc "처리 성공 여부",
         ApiResponse<*>::status bodyDesc "상태 코드",
+        ApiResponse<*>::data bodyDesc "응답 데이터",
         ApiResponse<*>::timestamp bodyDesc "타임 스탬프"
     )
 

build.gradle.kts

@@ -77,4 +77,7 @@ subprojects {
             classpath += files(sourceSets.main.map { it.output })
         }
     }
+
+
+
 }