chore : api 설명 추가

kobaco/kobaco/src/main/java/core/kobaco/application/advertise/controller/AdvertiseController.java

@@ -4,6 +4,7 @@
 import core.kobaco.application.advertise.service.dto.AdvertiseCreateRequest;
 import core.kobaco.application.advertise.service.dto.AdvertiseDetailResponse;
 import core.kobaco.application.advertise.service.dto.AdvertiseLikeDetailResponse;
+import io.swagger.v3.oas.annotations.Operation;
 import lombok.RequiredArgsConstructor;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.Pageable;
@@ -15,26 +16,33 @@
 public class AdvertiseController {
     private final AdvertiseService advertiseService;
 
+    @Operation(summary = "광고 생성")
     @PostMapping
     public void createAdvertise(AdvertiseCreateRequest request) {
         advertiseService.createAdvertise(request);
     }
 
+    @Operation(summary = "광고 목록 조회")
     @GetMapping
     public Page<String> getAdvertiseList(Pageable pageable) {
         return null;
     }
 
+    @Operation(summary = "광고 상세 조회")
     @GetMapping("/{advertiseId}")
     public AdvertiseDetailResponse getAdvertise(@PathVariable Long advertiseId) {
         return advertiseService.getAdvertise(advertiseId);
     }
 
+    @Operation(summary = "광고 좋아요", description = """
+        좋아요가 아니면 좋아요를 추가하고, 좋아요면 좋아요를 취소합니다.
+        """)
     @PatchMapping("/{advertiseId}/like")
     public void likeAdvertise(@PathVariable Long advertiseId) {
         advertiseService.likeAdvertise(advertiseId);
     }
 
+    @Operation(summary = "광고 좋아요 조회")
     @GetMapping("/{advertiseId}/like")
     public AdvertiseLikeDetailResponse getAdvertiseLikeCount(@PathVariable Long advertiseId) {
         return advertiseService.getAdvertiseLikeCount(advertiseId);

kobaco/kobaco/src/main/java/core/kobaco/application/advertisesave/controller/AdvertiseSaveController.java

@@ -2,6 +2,7 @@
 
 import core.kobaco.application.advertisesave.service.AdvertiseSaveService;
 import core.kobaco.application.advertisesave.service.dto.AdvertiseSaveRequest;
+import io.swagger.v3.oas.annotations.Operation;
 import lombok.RequiredArgsConstructor;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
@@ -15,11 +16,16 @@ public class AdvertiseSaveController {
     private final AdvertiseSaveService advertiseSaveService;
 
 
+    @Operation(summary = "광고 저장",
+    description = """
+        광고를 저장할 때, 광고 id와 파일 id를 통해 저장합니다.
+        """)
     @PostMapping("/advertises")
     public void saveAdvertise(@RequestBody AdvertiseSaveRequest request){
         advertiseSaveService.saveAdvertise(request.directoryId(), request.advertiseId());
     }
 
+    @Operation(summary = "광고 캡쳐 저장")
     @PostMapping("/advertises/capture")
     public void saveAdvertiseCapture(){
 

kobaco/kobaco/src/main/java/core/kobaco/application/file/controller/FileController.java

@@ -4,13 +4,8 @@
 import core.kobaco.application.file.service.dto.DirectoryCreateRequest;
 import core.kobaco.application.file.service.dto.DirectoryDetailResponse;
 import core.kobaco.application.file.service.dto.DirectoryUpdateRequest;
-import core.kobaco.application.file.service.dto.NamespaceDetailResponse;
-import io.swagger.v3.oas.annotations.Parameter;
-import io.swagger.v3.oas.annotations.enums.ParameterIn;
-import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.Operation;
 import lombok.RequiredArgsConstructor;
-import org.springdoc.core.annotations.ParameterObject;
-import org.springframework.lang.Nullable;
 import org.springframework.web.bind.annotation.*;
 
 
@@ -20,20 +15,35 @@
 public class FileController {
     private final FileService fileService;
 
+    @Operation(summary = "디렉토리 조회, 빈값으로 조회시 최상위 디렉토리 조회", description =
+        """
+        디렉토리 조회, 
+        빈값으로 조회시 최상위 디렉토리 조회
+        디렉토리 id값을 넣어서 조회하면 해당 디렉토리의 하위 디렉토리와 파일을 조회합니다.
+
+        조회시 디렉토리, 캡쳐 이미지, 광고 조회할 수 있습니다.
+
+        File Type:
+        - DIRECTORY: 디렉토리   
+        - CAPTURE: 캡쳐 이미지
+        - ADVERTISE: 광고
+            """)
     @GetMapping(path = {"/{directoryId}", ""})
     public DirectoryDetailResponse getFiles(
         @PathVariable(required = false) Long directoryId) {
         return fileService.getFiles(directoryId);
     }
 
 
+    @Operation(summary = "디렉토리 생성")
     @PostMapping("/{directoryId}")
     public void createDirectory(
         @PathVariable Long directoryId,
         @RequestBody DirectoryCreateRequest request) {
         fileService.createDirectory(directoryId, request);
     }
 
+    @Operation(summary = "디렉토리 이름 수정")
     @PatchMapping("/{directoryId}")
     public void updateDirectoryName(
         @PathVariable Long directoryId,

kobaco/kobaco/src/main/java/core/kobaco/application/user/controller/UserController.java

@@ -3,6 +3,7 @@
 import core.kobaco.application.user.service.UserService;
 import core.kobaco.application.user.service.dto.request.UserLoginRequest;
 import core.kobaco.application.user.service.dto.response.UserLoginResponse;
+import io.swagger.v3.oas.annotations.Operation;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.web.bind.annotation.PostMapping;
@@ -17,6 +18,7 @@
 public class UserController {
     private final UserService userService;
 
+    @Operation(summary = "로그인")
     @PostMapping("/login")
     public UserLoginResponse login(@RequestBody UserLoginRequest request){
         return userService.login(request);