Feature/23 set swagger

casper-feed/src/main/kotlin/hs/kr/entrydsm/feed/domain/attachFile/adapter/in/web/AttachFileWebAdapter.kt

@@ -1,6 +1,7 @@
 package hs.kr.entrydsm.feed.domain.attachFile.adapter.`in`.web
 
 import hs.kr.entrydsm.feed.domain.attachFile.application.service.CreateAttachFileService
+import hs.kr.entrydsm.feed.global.document.attachFile.AttachFileApiDocument
 import org.springframework.web.bind.annotation.PostMapping
 import org.springframework.web.bind.annotation.RequestMapping
 import org.springframework.web.bind.annotation.RequestPart
@@ -19,7 +20,7 @@ import org.springframework.web.multipart.MultipartFile
 @RequestMapping("/attach-file")
 class AttachFileWebAdapter(
     private val createAttachFileUseCase: CreateAttachFileService,
-) {
+) : AttachFileApiDocument {
     /**
      * 하나 이상의 첨부 파일을 업로드하고, 업로드된 파일 정보를 반환합니다.
      *
@@ -36,7 +37,7 @@ class AttachFileWebAdapter(
      * @see CreateAttachFileService.execute
      */
     @PostMapping
-    fun createAttachFile(
+    override fun createAttachFile(
         @RequestPart(value = "attach_file") attachFile: List<MultipartFile>,
     ) = createAttachFileUseCase.execute(attachFile)
 }

casper-feed/src/main/kotlin/hs/kr/entrydsm/feed/domain/faq/adapter/in/web/FaqWebAdapter.kt

@@ -12,6 +12,7 @@ import hs.kr.entrydsm.feed.domain.faq.application.port.`in`.QueryFaqListUseCase
 import hs.kr.entrydsm.feed.domain.faq.application.port.`in`.QueryTopFaqUseCase
 import hs.kr.entrydsm.feed.domain.faq.application.port.`in`.UpdateFaqUseCase
 import hs.kr.entrydsm.feed.domain.faq.model.type.FaqType
+import hs.kr.entrydsm.feed.global.document.faq.FaqApiDocument
 import org.springframework.http.HttpStatus
 import org.springframework.validation.annotation.Validated
 import org.springframework.web.bind.annotation.DeleteMapping
@@ -50,10 +51,11 @@ class FaqWebAdapter(
     private val queryFaqListUseCase: QueryFaqListUseCase,
     private val queryTopFaqUseCase: QueryTopFaqUseCase,
     private val updateFaqUseCase: UpdateFaqUseCase,
-) {
+) : FaqApiDocument {
+
     @ResponseStatus(HttpStatus.CREATED)
     @PostMapping
-    fun createFaq(
+    override fun createFaq(
         @RequestBody @Validated
         createFaqRequest: CreateFaqRequest,
     ) = createFaqUseCase.execute(createFaqRequest)
@@ -65,7 +67,7 @@ class FaqWebAdapter(
      * @return FAQ 상세 정보가 포함된 응답 객체
      */
     @GetMapping("/{faq-id}")
-    fun queryFaqDetails(
+    override fun queryFaqDetails(
         @PathVariable("faq-id") faqId: UUID,
     ): FaqDetailsResponse = queryFaqDetailsUseCase.execute(faqId)
 
@@ -76,7 +78,7 @@ class FaqWebAdapter(
      * @return 해당 유형의 FAQ 목록이 포함된 응답 객체
      */
     @GetMapping
-    fun queryFaqListByType(
+    override fun queryFaqListByType(
         @RequestParam("type") faqType: FaqType,
     ): FaqListResponse = queryFaqListByTypeUseCase.execute(faqType)
 
@@ -86,15 +88,15 @@ class FaqWebAdapter(
      * @return 모든 FAQ 목록이 포함된 응답 객체
      */
     @GetMapping("/all")
-    fun queryFaqList(): FaqListResponse = queryFaqListUseCase.execute()
+    override fun queryFaqList(): FaqListResponse = queryFaqListUseCase.execute()
 
     /**
      * 최근에 등록된 FAQ 목록을 조회합니다.
      *
      * @return 최근 FAQ 목록이 포함된 응답 객체
      */
     @GetMapping("/recently")
-    fun queryTopFaq() = queryTopFaqUseCase.execute()
+    override fun queryTopFaq() = queryTopFaqUseCase.execute()
 
     /**
      * 기존 FAQ를 수정합니다.
@@ -103,7 +105,7 @@ class FaqWebAdapter(
      * @param updateFaqRequest FAQ 수정 요청 데이터
      */
     @PatchMapping("/{faq-id}")
-    fun updateFaq(
+    override fun updateFaq(
         @PathVariable("faq-id") faqId: UUID,
         @RequestBody @Validated
         updateFaqRequest: UpdateFaqRequest,
@@ -115,7 +117,7 @@ class FaqWebAdapter(
      * @param faqId 삭제할 FAQ의 고유 식별자
      */
     @DeleteMapping("/{faq-id}")
-    fun deleteFaq(
+    override fun deleteFaq(
         @PathVariable("faq-id") faqId: UUID,
     ) = deleteFaqUseCase.execute(faqId)
 }

casper-feed/src/main/kotlin/hs/kr/entrydsm/feed/domain/notice/adapter/in/web/NoticeWebAdapter.kt

@@ -14,6 +14,7 @@ import hs.kr.entrydsm.feed.domain.notice.application.port.`in`.QueryNoticeTitleU
 import hs.kr.entrydsm.feed.domain.notice.application.port.`in`.UpdateNoticeUseCase
 import hs.kr.entrydsm.feed.domain.notice.application.port.`in`.UploadNoticeImageUseCase
 import hs.kr.entrydsm.feed.domain.notice.model.type.NoticeType
+import hs.kr.entrydsm.feed.global.document.notice.NoticeApiDocument
 import jakarta.validation.Valid
 import org.springframework.http.HttpStatus
 import org.springframework.http.ResponseEntity
@@ -45,15 +46,15 @@ class NoticeWebAdapter(
     private val queryNoticeTitleUseCase: QueryNoticeTitleUseCase,
     private val uploadNoticeImageUseCase: UploadNoticeImageUseCase,
     private val queryListNoticeListByTypeUseCase: QueryNoticeListByTypeUseCase,
-) {
+) : NoticeApiDocument {
     /**
      * 새로운 공지사항을 생성합니다.
      *
      * @param createNoticeRequest 공지사항 생성 요청 데이터
      */
     @ResponseStatus(value = HttpStatus.CREATED)
     @PostMapping
-    fun createNotice(
+    override fun createNotice(
         @RequestBody @Valid
         createNoticeRequest: CreateNoticeRequest,
     ) {
@@ -68,7 +69,7 @@ class NoticeWebAdapter(
      * @return 수정 결과에 대한 응답 엔티티
      */
     @PatchMapping("/{notice-id}")
-    fun updateNotice(
+    override fun updateNotice(
         @PathVariable(name = "notice-id") id: UUID,
         @RequestBody updateNoticeRequest: UpdateNoticeRequest,
     ): ResponseEntity<String> = updateNoticeUseCase.execute(id, updateNoticeRequest)
@@ -80,7 +81,7 @@ class NoticeWebAdapter(
      * @return 업로드된 이미지 정보가 포함된 응답 객체
      */
     @PostMapping("/image")
-    fun uploadImage(
+    override fun uploadImage(
         @RequestPart(name = "photo") image: MultipartFile,
     ): UploadNoticeImageResponse = uploadNoticeImageUseCase.execute(image)
 
@@ -90,7 +91,7 @@ class NoticeWebAdapter(
      * @return 공지사항 제목 목록이 포함된 응답 객체 리스트
      */
     @GetMapping("/title")
-    fun queryNoticeTitle(): List<QueryNoticeTitleResponse> = queryNoticeTitleUseCase.execute()
+    override fun queryNoticeTitle(): List<QueryNoticeTitleResponse> = queryNoticeTitleUseCase.execute()
 
     /**
      * 특정 공지사항의 상세 정보를 조회합니다.
@@ -99,7 +100,7 @@ class NoticeWebAdapter(
      * @return 공지사항 상세 정보가 포함된 응답 객체
      */
     @GetMapping("/{notice-id}")
-    fun queryDetailsNotice(
+    override fun queryDetailsNotice(
         @PathVariable(name = "notice-id", required = true)
         noticeId: UUID,
     ): QueryDetailsNoticeResponse = queryDetailsNoticeUseCase.execute(noticeId)
@@ -111,7 +112,7 @@ class NoticeWebAdapter(
      * @return 해당 유형의 공지사항 목록이 포함된 응답 객체
      */
     @GetMapping
-    fun queryNoticeListByType(
+    override fun queryNoticeListByType(
         @RequestParam("type") noticeType: NoticeType?,
     ): QueryListNoticeResponse = queryListNoticeListByTypeUseCase.execute(noticeType)
 
@@ -122,7 +123,7 @@ class NoticeWebAdapter(
      */
     @ResponseStatus(value = HttpStatus.NO_CONTENT)
     @DeleteMapping("/{notice-id}")
-    fun deleteNotice(
+    override fun deleteNotice(
         @PathVariable(name = "notice-id")id: UUID,
     ) = deleteNoticeUseCase.execute(id)
 }

casper-feed/src/main/kotlin/hs/kr/entrydsm/feed/domain/reserve/adapter/in/web/ReserveWebAdapter.kt

@@ -1,6 +1,7 @@
 package hs.kr.entrydsm.feed.domain.reserve.adapter.`in`.web
 
 import hs.kr.entrydsm.feed.domain.reserve.application.port.`in`.GetReserveUseCase
+import hs.kr.entrydsm.feed.global.document.reserve.ReserveApiDocument
 import org.springframework.web.bind.annotation.GetMapping
 import org.springframework.web.bind.annotation.RequestMapping
 import org.springframework.web.bind.annotation.RestController
@@ -17,12 +18,12 @@ import org.springframework.web.bind.annotation.RestController
 @RequestMapping("/reserve")
 class ReserveWebAdapter(
     private val getReserveUseCase: GetReserveUseCase,
-) {
+) : ReserveApiDocument {
     /**
      * 예약 페이지 링크를 조회합니다.
      *
      * @return 예약 페이지 URL 문자열
      */
     @GetMapping
-    fun reserveLink(): String = getReserveUseCase.execute()
+    override fun reserveLink(): String = getReserveUseCase.execute()
 }

casper-feed/src/main/kotlin/hs/kr/entrydsm/feed/domain/screen/adatper/in/web/ScreenWebAdapter.kt

@@ -5,6 +5,7 @@ import hs.kr.entrydsm.feed.domain.screen.adatper.`in`.web.dto.response.ScreenRes
 import hs.kr.entrydsm.feed.domain.screen.application.port.`in`.CreateScreenUseCase
 import hs.kr.entrydsm.feed.domain.screen.application.port.`in`.QueryScreenUseCase
 import hs.kr.entrydsm.feed.domain.screen.application.port.`in`.UpdateScreenUseCase
+import hs.kr.entrydsm.feed.global.document.screen.ScreenApiDocument
 import org.springframework.http.HttpStatus
 import org.springframework.web.bind.annotation.GetMapping
 import org.springframework.web.bind.annotation.PatchMapping
@@ -33,7 +34,7 @@ class ScreenWebAdapter(
     private val createScreenUseCase: CreateScreenUseCase,
     private val updateScreenUseCase: UpdateScreenUseCase,
     private val queryScreenUseCase: QueryScreenUseCase,
-) {
+) : ScreenApiDocument {
     /**
      * 새로운 화면 이미지를 업로드하고 저장합니다.
      *
@@ -42,7 +43,7 @@ class ScreenWebAdapter(
      */
     @ResponseStatus(value = HttpStatus.CREATED)
     @PostMapping
-    suspend fun createScreen(
+    override suspend fun createScreen(
         @RequestPart(name = "image") image: MultipartFile,
     ): ScreenResponse = createScreenUseCase.execute(image)
 
@@ -54,7 +55,7 @@ class ScreenWebAdapter(
      * @return 업데이트된 화면 이미지 정보가 포함된 응답 객체
      */
     @PatchMapping("/{screen-id}")
-    fun updateScreen(
+    override fun updateScreen(
         @PathVariable(name = "screen-id") id: UUID,
         @RequestPart(name = "image") image: MultipartFile,
     ): ScreenResponse = updateScreenUseCase.execute(id, image)
@@ -65,5 +66,5 @@ class ScreenWebAdapter(
      * @return 화면 이미지 목록이 포함된 응답 객체 리스트
      */
     @GetMapping
-    fun queryScreen(): List<QueryScreenResponse> = queryScreenUseCase.execute()
+    override fun queryScreen(): List<QueryScreenResponse> = queryScreenUseCase.execute()
 }

casper-feed/src/main/kotlin/hs/kr/entrydsm/feed/global/document/attachFile/AttachFileApiDocument.kt

@@ -0,0 +1,36 @@
+package hs.kr.entrydsm.feed.global.document.attachFile
+
+import hs.kr.entrydsm.feed.domain.attachFile.adapter.`in`.web.dto.response.CreateAttachFileResponse
+import io.swagger.v3.oas.annotations.tags.Tag
+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 org.springframework.web.bind.annotation.RequestPart
+import org.springframework.web.multipart.MultipartFile
+
+/**
+ * AttachFile API 문서화를 위한 인터페이스입니다.
+ */
+@Tag(name = "AttachFile", description = "첨부 파일 API")
+interface AttachFileApiDocument {
+
+    @Operation(
+        summary = "첨부 파일 업로드",
+        description =
+            "1. 이미 동일한 이름의 파일이 존재하면 삭제합니다.\n" +
+            "2. 파일을 S3에 업로드합니다.\n" +
+            "3. 업로드된 파일 정보를 데이터베이스에 저장합니다.\n" +
+            "4. 업로드된 파일에 접근할 수 있는 URL을 생성하여 응답을 반환합니다."
+    )
+    @ApiResponses(
+        ApiResponse(
+            responseCode = "200",
+            description = "파일 업로드 성공",
+            content = arrayOf(Content())
+        )
+    )
+    fun createAttachFile(
+        @RequestPart(value = "attach_file") attachFile: List<MultipartFile>,
+    ): List<CreateAttachFileResponse>
+}