Merge pull request #310 from HoeSeong123/docs/crud_wagger_refactor

예외처리 문서화 추가

backend/src/main/java/codezap/category/controller/SpringDocCategoryController.java

@@ -28,7 +28,7 @@ public interface SpringDocCategoryController {
     @ApiErrorResponse(status = HttpStatus.BAD_REQUEST, instance = "/categories", errorCases = {
             @ErrorCase(description = "모든 필드 중 null인 값이 있는 경우", exampleMessage = "카테고리 이름이 null 입니다."),
             @ErrorCase(description = "카테고리 이름이 255자를 초과한 경우", exampleMessage = "카테고리 이름은 최대 255자까지 입력 가능합니다."),
-            @ErrorCase(description = "동일한 이름의 카테고리가 존재하는 경우", exampleMessage = "이름이 Spring 인 카테고리가 이미 존재합니다.")
+            @ErrorCase(description = "동일한 이름의 카테고리가 존재하는 경우", exampleMessage = "이름이 Spring 인 카테고리가 이미 존재합니다."),
     })
     ResponseEntity<Void> createCategory(CreateCategoryRequest createCategoryRequest, MemberDto memberDto);
 
@@ -43,7 +43,9 @@ public interface SpringDocCategoryController {
             @ErrorCase(description = "해당하는 id 값인 카테고리가 없는 경우",
                     exampleMessage = "식별자 1에 해당하는 카테고리가 존재하지 않습니다."),
             @ErrorCase(description = "동일한 이름의 카테고리가 존재하는 경우",
-                    exampleMessage = "이름이 Spring 인 카테고리가 이미 존재합니다.")
+                    exampleMessage = "이름이 Spring 인 카테고리가 이미 존재합니다."),
+            @ErrorCase(description = "카테고리를 수정할 권한이 없는 경우",
+                    exampleMessage = "해당 카테고리를 수정 또는 삭제할 권한이 없는 유저입니다.")
     })
     ResponseEntity<Void> updateCategory(Long id, UpdateCategoryRequest updateCategoryRequest, MemberDto memberDto);
 
@@ -52,6 +54,8 @@ public interface SpringDocCategoryController {
     @ApiErrorResponse(status = HttpStatus.BAD_REQUEST, instance = "/categories/1", errorCases = {
             @ErrorCase(description = "삭제하려는 카테고리에 템플릿이 존재하는 경우",
                     exampleMessage = "템플릿이 존재하는 카테고리는 삭제할 수 없습니다."),
+            @ErrorCase(description = "카테고리를 삭제할 권한이 없는 경우",
+                    exampleMessage = "해당 카테고리를 수정 또는 삭제할 권한이 없는 유저입니다.")
     })
     ResponseEntity<Void> deleteCategory(Long id, MemberDto memberDto);
 }

backend/src/main/java/codezap/template/controller/SpringDocTemplateController.java

@@ -65,6 +65,7 @@ ResponseEntity<FindAllTemplatesResponse> getTemplates(
             content = {@Content(schema = @Schema(implementation = ExploreTemplatesResponse.class))})
     @ApiErrorResponse(status = HttpStatus.BAD_REQUEST, instance = "/templates/1", errorCases = {
             @ErrorCase(description = "해당하는 id 값인 템플릿이 없는 경우", exampleMessage = "식별자 1에 해당하는 템플릿이 존재하지 않습니다."),
+            @ErrorCase(description = "템플릿을 가져올 권한이 없는 경우", exampleMessage = "해당 템플릿에 대한 권한이 없는 유저입니다."),
     })
     ResponseEntity<FindTemplateResponse> getTemplateById(Long id, MemberDto memberDto);
 
@@ -79,10 +80,17 @@ ResponseEntity<FindAllMyTemplatesResponse> getMyTemplatesContainTopic(
     @ApiResponse(responseCode = "200", description = "템플릿 수정 성공")
     @ApiErrorResponse(status = HttpStatus.BAD_REQUEST, instance = "/templates/1", errorCases = {
             @ErrorCase(description = "해당하는 id 값인 템플릿이 없는 경우", exampleMessage = "식별자 1에 해당하는 템플릿이 존재하지 않습니다."),
+            @ErrorCase(description = "템플릿을 수정할 권한이 없는 경우", exampleMessage = "해당 템플릿에 대한 권한이 없는 유저입니다."),
+
     })
     ResponseEntity<Void> updateTemplate(Long id, UpdateTemplateRequest updateTemplateRequest, MemberDto memberDto);
 
     @Operation(summary = "템플릿 삭제", description = "해당하는 식별자의 템플릿을 삭제합니다.")
     @ApiResponse(responseCode = "204", description = "템플릿 삭제 성공")
+    @ApiErrorResponse(status = HttpStatus.BAD_REQUEST, instance = "/templates/1", errorCases = {
+            @ErrorCase(description = "해당하는 id 값인 템플릿이 없는 경우", exampleMessage = "식별자 1에 해당하는 템플릿이 존재하지 않습니다."),
+            @ErrorCase(description = "템플릿을 수정할 권한이 없는 경우", exampleMessage = "해당 템플릿에 대한 권한이 없는 유저입니다."),
+
+    })
     ResponseEntity<Void> deleteTemplate(Long id, MemberDto memberDto);
 }