refac : api 별 swagger operation 적용

Author: pstar987

src/main/java/medilux/aquabe/domain/compatibility/controller/RecommendationPerTypeController.java

@@ -1,5 +1,6 @@
 package medilux.aquabe.domain.compatibility.controller;
 
+import io.swagger.v3.oas.annotations.Operation;
 import lombok.RequiredArgsConstructor;
 import medilux.aquabe.domain.compatibility.dto.RecommendationPerTypeResponse;
 import medilux.aquabe.domain.compatibility.service.RecommendationPerTypeService;
@@ -15,6 +16,9 @@ public class RecommendationPerTypeController {
     private final RecommendationPerTypeService recommendationPerTypeService;
 
     @GetMapping("/{type_name}/{category_id}")
+    @Operation(summary = "피부타입, 카텍고리별 제품 추천 api",
+            description = "type_name에는 피부타입을 입력해주세요<br>"
+                    + "categoryId는 제품 카테고리를 숫자로 입력해주세요 (ex. 1(토너), 2(세럼), 3(로션), 4(크림)).<br>")
     public ResponseEntity<List<RecommendationPerTypeResponse>> getRecommendations(
             @PathVariable("type_name") String typeName,
             @PathVariable("category_id") Integer categoryId) {

src/main/java/medilux/aquabe/domain/product/controller/ProductController.java

@@ -1,5 +1,6 @@
 package medilux.aquabe.domain.product.controller;
 
+import io.swagger.v3.oas.annotations.Operation;
 import lombok.RequiredArgsConstructor;
 import medilux.aquabe.domain.product.dto.ProductDetailSearchResponse;
 import medilux.aquabe.domain.product.dto.ProductSearchResponse;
@@ -23,6 +24,11 @@ public class ProductController {
 
     // 제품 검색 이름 API
     @GetMapping("/search")
+    @Operation(summary = "제품 검색 api",
+            description = "keyword에는 제품명을 입력해주세요.<br>"
+                    + "category는 제품 카테고리를 숫자로 입력해주세요 (ex. 1(토너), 2(세럼), 3(로션), 4(크림)).<br>"
+                    + "type에는 피부타입을 입력해주세요 (ex. 미입력시 전체, OMR, ODS...). <br>"
+                    + "인기순으로 정렬되어서 반환해줍니다.")
     public ResponseEntity<List<ProductSearchResponse>> searchProducts(
             @RequestParam(name = "keyword", required = false) String keyword,
             @RequestParam(name = "category", required = false) Integer category,

src/main/java/medilux/aquabe/domain/search/controller/SearchKeywordController.java

@@ -1,5 +1,6 @@
 package medilux.aquabe.domain.search.controller;
 
+import io.swagger.v3.oas.annotations.Operation;
 import lombok.RequiredArgsConstructor;
 import medilux.aquabe.domain.search.dto.PopularKeywordResponse;
 import medilux.aquabe.domain.search.dto.RecentKeywordResponse;
@@ -19,11 +20,15 @@ public class SearchKeywordController {
     private final SearchLogService searchLogService;
 
     @GetMapping("/popular")
+    @Operation(summary = "인기 검색어 표출 api",
+            description = "인기검색어는 상위 10개를 표출한 후 1시간 마다 삭제됩니다.(배치 적용됨)")
     public ResponseEntity<List<PopularKeywordResponse>> getPopularKeywords() {
         return ResponseEntity.ok(searchLogService.getTop10SearchKeywords());
     }
 
     @GetMapping("/recent")
+    @Operation(summary = "최근 검색어 표출 api",
+            description = "최근검색어는 해당 유저의 최근 검색어를 표출합니다.")
     public ResponseEntity<RecentKeywordResponse> getRecentKeywords(){
         Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
         String loginEmail = authentication.getName();

src/main/java/medilux/aquabe/domain/type/controller/SkinTypeUsersController.java

@@ -1,5 +1,6 @@
 package medilux.aquabe.domain.type.controller;
 
+import io.swagger.v3.oas.annotations.Operation;
 import lombok.RequiredArgsConstructor;
 import medilux.aquabe.domain.type.dto.SkinTypeUsersResponse;
 import medilux.aquabe.domain.type.service.SkinTypeUserService;
@@ -17,6 +18,9 @@ public class SkinTypeUsersController {
 
     // 특정 피부 타입 유저들 보여주기
     @GetMapping("/{type_name}/users/vanities")
+    @Operation(summary = "특정 피부 타입 유저 표출 api(수정 필요)",
+            description = "type_name에 피부타입을 입력해주세요. <br>"
+                    + "상위권인지는 추후에 랭킹으로 정렬해서 다시 반영하겠습니다.")
     public ResponseEntity<SkinTypeUsersResponse> getUsersBySkinType(@PathVariable("type_name") String typeName) {
         SkinTypeUsersResponse response = skinTypeUserService.getUsersBySkinType(typeName);
         return ResponseEntity.ok(response);