From 7de58b2367383ed158f268d411b8d17450677c78 Mon Sep 17 00:00:00 2001 From: jeongeungyeong Date: Wed, 2 Oct 2024 07:21:07 +0900 Subject: [PATCH] =?UTF-8?q?feat:=20swagger=20Tag,=20Operation=20=EC=96=B4?= =?UTF-8?q?=EB=85=B8=ED=85=8C=EC=9D=B4=EC=85=98=20=EC=82=AC=EC=9A=A9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../ribbon/datapipe/controller/OpenApiController.java | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/main/java/wanted/ribbon/datapipe/controller/OpenApiController.java b/src/main/java/wanted/ribbon/datapipe/controller/OpenApiController.java index c13a33b..9140070 100644 --- a/src/main/java/wanted/ribbon/datapipe/controller/OpenApiController.java +++ b/src/main/java/wanted/ribbon/datapipe/controller/OpenApiController.java @@ -1,6 +1,8 @@ package wanted.ribbon.datapipe.controller; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.tags.Tag; import lombok.RequiredArgsConstructor; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.*; @@ -12,24 +14,28 @@ @RestController @RequestMapping("/api/datapipes") @RequiredArgsConstructor +@Tag(name="DataPipe",description = "경기도 공공데이터 수집 관련 API입니다.") public class OpenApiController { private final GenrestrtService genrestrtService; private final RawDataService rawDataService; // 경기도 맛집 데이터 수집 API (RestTemplate), responsebody 사용으로 PostMapping으로 진행 @PostMapping("/fetch-data") + @Operation(summary = "경기도 맛집 수집", description = "경기도 맛집 데이터를 restTemplate 방식으로 가져옵니다. " + + "김밥, 중국식, 일식 등 일부 카테고리만 가져올 수 있습니다.") public ResponseEntity fetchData(@RequestParam("serviceName") String serviceName) { // openAPI 호출 genrestrtService.fetchAndSaveData(serviceName); return ResponseEntity.ok(serviceName + "가 db에 성공적으로 저장됐습니다."); } - // 경기도 맛집 데이터 수집 API (WebClient, 모든 경기도 맛집 api 가능) /** * 데이터 조회로 GetMapping 사용 * 비동기 처리를 위한 Mono 사용 */ @GetMapping("/fetch-and-save") + @Operation(summary = "경기도 맛집 수집", description = "경기도 맛집 데이터를 webClient 방식으로 가져옵니다. " + + "경기도 맛집의 모든 음식점 카테고리를 가져올 수 있습니다.") public Mono> fetchAndSaveData(@RequestParam("serviceName") String serviceName) { return rawDataService.getAndSaveByServiceName(serviceName) .map(ResponseEntity::ok)