feat: News API swagger 설명 추가

tukcomCD2024 · Apr 30, 2024 · b955ff3 · b955ff3
1 parent d211032
commit b955ff3
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 2 deletions.
diff --git a/backend/core/src/main/java/com/rollthedice/backend/domain/news/api/NewsApi.java b/backend/core/src/main/java/com/rollthedice/backend/domain/news/api/NewsApi.java
@@ -0,0 +1,23 @@
+package com.rollthedice.backend.domain.news.api;
+
+import com.rollthedice.backend.domain.news.dto.response.NewsResponse;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.security.SecurityRequirement;
+import org.springframework.data.domain.Pageable;
+
+import java.util.List;
+
+public interface NewsApi {
+    @Operation(
+            summary = "요약 뉴스 조회",
+            description = "요약 뉴스를 페이지로 나누어 조회합니다.",
+            security = {@SecurityRequirement(name = "access_token")},
+            tags = {"news"}
+    )
+    @ApiResponse(
+            responseCode = "200",
+            description = "OK"
+    )
+    List<NewsResponse> getNews(Pageable pageable);
+}
diff --git a/...omain/news/controller/NewsController.java → ...ckend/domain/news/api/NewsController.java b/...omain/news/controller/NewsController.java → ...ckend/domain/news/api/NewsController.java
@@ -1,4 +1,4 @@
-package com.rollthedice.backend.domain.news.controller;
+package com.rollthedice.backend.domain.news.api;
 
 import com.rollthedice.backend.domain.news.dto.response.NewsResponse;
 import com.rollthedice.backend.domain.news.service.NewsService;
@@ -12,11 +12,12 @@
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("news")
-public class NewsController {
+public class NewsController implements NewsApi {
     private final NewsService newsService;
 
     @ResponseStatus(HttpStatus.OK)
     @GetMapping("")
+    @Override
     public List<NewsResponse> getNews(final Pageable pageable) {
         return newsService.getNews(pageable);
     }