From 3b2feefe7aa0cda6ef8dcabcb36999089543158a Mon Sep 17 00:00:00 2001
From: changkyu choi <okoookoo@naver.com>
Date: Wed, 21 Aug 2024 12:30:57 +0900
Subject: [PATCH] =?UTF-8?q?RequestMapping=20=EC=88=98=EC=A0=95=20=EB=B0=8F?=
 =?UTF-8?q?=20description=20=EC=B6=94=EA=B0=80?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../canvasStatus/CanvasStatusController.java  | 37 ++++++++++---------
 .../biz/canvasStatus/CanvasStatusMapper.java  |  4 +-
 .../biz/canvasStatus/CanvasStatusService.java |  8 +---
 3 files changed, 24 insertions(+), 25 deletions(-)

diff --git a/src/main/java/com/interplug/qcast/biz/canvasStatus/CanvasStatusController.java b/src/main/java/com/interplug/qcast/biz/canvasStatus/CanvasStatusController.java
index 902c6b06..92480c01 100644
--- a/src/main/java/com/interplug/qcast/biz/canvasStatus/CanvasStatusController.java
+++ b/src/main/java/com/interplug/qcast/biz/canvasStatus/CanvasStatusController.java
@@ -2,6 +2,9 @@ package com.interplug.qcast.biz.canvasStatus;
 
 import com.interplug.qcast.biz.canvasStatus.dto.CanvasStatus;
 import com.interplug.qcast.biz.canvasStatus.dto.CanvasStatusResponse;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import lombok.RequiredArgsConstructor;
 
 import java.util.List;
@@ -10,46 +13,46 @@ import org.springframework.http.HttpStatus;
 import org.springframework.web.bind.annotation.*;
 
 @RestController
-@RequestMapping("/api/canvasStatus")
+@RequestMapping("/api/canvas-management")
 @RequiredArgsConstructor
+@Tag(name = "CanvasStatusController", description = "Canvas 관련 API")
 public class CanvasStatusController {
-  // @Autowired private CanvasStatusService canvasStatusService;
   private final CanvasStatusService canvasStatusService;
 
-  // 전체 견적서 조회
-  @GetMapping("/list/{userId}")
+  @Operation(description = "계정에 해당하는 전체 견적서를 조회 한다.")
+  @GetMapping("/canvas-statuses/{userId}")
   public List<CanvasStatusResponse> selectAllCanvasStatus(@PathVariable String userId) {
     return canvasStatusService.selectAllCanvasStatus(userId);
   }
   
-  //견적서 조회
-  @GetMapping("/{objectNo}")
+  @Operation(description = "견적서를 조회 한다.")
+  @GetMapping("/canvas-statuses/{objectNo}")
   public List<CanvasStatusResponse> selectObjectNoCanvasStatus(@PathVariable String objectNo) {
     return canvasStatusService.selectObjectNoCanvasStatus(objectNo);
   }
   
-  // 견적서 등록
-  @PostMapping
+  @Operation(description = "견적서를 등록 한다.")
+  @PostMapping("/canvas-statuses")
   @ResponseStatus(HttpStatus.CREATED)
-  public String insertCanvasStatus(@RequestBody CanvasStatus cs) {  
+  public String insertCanvasStatus(@RequestBody CanvasStatus cs) {
       return canvasStatusService.insertCanvasStatus(cs);
   }
 
-  // 견적서 수정
-  @PutMapping("/{id}/{canvasStatus}")
-  public void updateCanvasStatus(@PathVariable Integer id, @PathVariable String canvasStatus) {
-      canvasStatusService.updateCanvasStatus(id, canvasStatus);
+  @Operation(description = "견적서를 수정 한다.")
+  @PutMapping("/canvas-statuses")
+  public void updateCanvasStatus(@RequestBody CanvasStatus cs) {
+      canvasStatusService.updateCanvasStatus(cs);
   }
   
-  // 견적서 삭제
-  @DeleteMapping("/all/{objectNo}")
+  @Operation(description = "견적서를 삭제 한다.")
+  @DeleteMapping("/canvas-statuses/{objectNo}")
   @ResponseStatus(HttpStatus.NO_CONTENT)
   public void deleteObjectNoCanvasStatus(@PathVariable String objectNo) {
       canvasStatusService.deleteObjectNoCanvasStatus(objectNo);
   }
   
-  // 이미지(템플릿) 삭제
-  @DeleteMapping("/{id}")
+  @Operation(description = "견적서의 이미지(템플릿)를 삭제 한다.")
+  @DeleteMapping("/canvas-statuses/{id}")
   @ResponseStatus(HttpStatus.NO_CONTENT)
   public void deleteImageNameCanvasStatus(@PathVariable Integer id) {
       canvasStatusService.deleteImageNameCanvasStatus(id);
diff --git a/src/main/java/com/interplug/qcast/biz/canvasStatus/CanvasStatusMapper.java b/src/main/java/com/interplug/qcast/biz/canvasStatus/CanvasStatusMapper.java
index e17e4b67..c00dc9ca 100644
--- a/src/main/java/com/interplug/qcast/biz/canvasStatus/CanvasStatusMapper.java
+++ b/src/main/java/com/interplug/qcast/biz/canvasStatus/CanvasStatusMapper.java
@@ -8,7 +8,7 @@ import java.util.List;
 import org.apache.ibatis.annotations.Mapper;
 
 @Mapper
-interface CanvasStatusMapper {
+public interface CanvasStatusMapper {
 
 	// objectNo 생성
 	public String getCanvasStatusNewObjectNo(String userId);
@@ -26,7 +26,7 @@ interface CanvasStatusMapper {
 	public void insertCanvasStatus(CanvasStatus cs);
 	
 	// 견적서 수정
-	public void updateCanvasStatus(Integer id, String canvasStatus);
+	public void updateCanvasStatus(CanvasStatus cs);
 	
 	// 견적서 삭제
 	public void deleteObjectNoCanvasStatus(String objectNo);
diff --git a/src/main/java/com/interplug/qcast/biz/canvasStatus/CanvasStatusService.java b/src/main/java/com/interplug/qcast/biz/canvasStatus/CanvasStatusService.java
index 263dee80..0cedab71 100644
--- a/src/main/java/com/interplug/qcast/biz/canvasStatus/CanvasStatusService.java
+++ b/src/main/java/com/interplug/qcast/biz/canvasStatus/CanvasStatusService.java
@@ -57,12 +57,8 @@ public class CanvasStatusService {
     }
 
 	// 견적서 수정
-    public void updateCanvasStatus(Integer id, String canvasStatus) {
-    	//CanvasStatus cs = new CanvasStatus();
-    	//cs.setId(id);
-    	//cs.setCanvasStatus(canvasStatus);
-    	//canvasStatusMapper.updateCanvasStatus(cs);
-    	canvasStatusMapper.updateCanvasStatus(id, canvasStatus);
+    public void updateCanvasStatus(CanvasStatus cs) {
+    	canvasStatusMapper.updateCanvasStatus(cs);
     }
 
 	// 견적서 삭제