fix: swagger status code가 실제와 일치하지 않던 부분 수정

RollingPaper42 · Feb 2, 2024 · 75152ee · 75152ee
2 parents 0ae16b0 + b35b448
commit 75152ee
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 3 deletions.
diff --git a/src/main/java/com/strcat/controller/BoardController.java b/src/main/java/com/strcat/controller/BoardController.java
@@ -28,9 +28,12 @@
 @Tag(name = "보드 및 컨텐츠")
 @ApiResponses({
         @ApiResponse(responseCode = "200", description = "성공"),
-        @ApiResponse(responseCode = "401", description = "인증 실패"),
-        @ApiResponse(responseCode = "406", description = "잘못된 요청"),
-        @ApiResponse(responseCode = "500", description = "서버 에러"),
+        @ApiResponse(responseCode = "406", description = "잘못된 요청", content = {
+                @Content(examples = {@ExampleObject("잘못된 요청")})
+        }),
+        @ApiResponse(responseCode = "500", description = "서버 에러", content = {
+                @Content(examples = {@ExampleObject("서버 에러")})
+        }),
 })
 @RestController
 @RequestMapping("/boards")
@@ -44,6 +47,9 @@ public class BoardController {
     @Operation(summary = "보드 생성", description = "생성 성공 후 board의 encryptedId를 반환합니다.")
     @ApiResponse(responseCode = "200", description = "성공", content = {
             @Content(examples = {@ExampleObject("Wd5lUSQnmEjnMVl043cEzZzNqqrA3Z9pBAVImYNwI14=")})})
+    @ApiResponse(responseCode = "401", description = "인증 실패", content = {
+            @Content(examples = {@ExampleObject("인증 실패")})
+    })
     public String createBoard(@Parameter(hidden = true) @RequestHeader("Authorization") String token,
                               @RequestBody CreateBoardReqDto dto) {
         return boardService.createBoard(dto, token);

diff --git a/src/main/java/com/strcat/controller/LoginController.java b/src/main/java/com/strcat/controller/LoginController.java
@@ -4,6 +4,10 @@
 import com.strcat.service.UserService;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.ExampleObject;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
 import io.swagger.v3.oas.annotations.security.SecurityRequirement;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import lombok.RequiredArgsConstructor;
@@ -13,6 +17,15 @@
 import org.springframework.web.bind.annotation.RestController;
 
 @Tag(name = "로그인")
+@ApiResponses({
+        @ApiResponse(responseCode = "200", description = "성공"),
+        @ApiResponse(responseCode = "406", description = "잘못된 요청", content = {
+                @Content(examples = {@ExampleObject("잘못된 요청")})
+        }),
+        @ApiResponse(responseCode = "500", description = "서버 에러", content = {
+                @Content(examples = {@ExampleObject("서버 에러")})
+        }),
+})
 @RestController
 @RequestMapping("/login")
 @RequiredArgsConstructor

diff --git a/src/main/java/com/strcat/controller/UserController.java b/src/main/java/com/strcat/controller/UserController.java
@@ -5,6 +5,10 @@
 import com.strcat.service.BoardService;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.ExampleObject;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
 import io.swagger.v3.oas.annotations.security.SecurityRequirement;
 import java.util.List;
 import lombok.RequiredArgsConstructor;
@@ -13,6 +17,18 @@
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
+@ApiResponses({
+        @ApiResponse(responseCode = "200", description = "성공"),
+        @ApiResponse(responseCode = "401", description = "인증 실패", content = {
+                @Content(examples = {@ExampleObject("인증 실패")})
+        }),
+        @ApiResponse(responseCode = "406", description = "잘못된 요청", content = {
+                @Content(examples = {@ExampleObject("잘못된 요청")})
+        }),
+        @ApiResponse(responseCode = "500", description = "서버 에러", content = {
+                @Content(examples = {@ExampleObject("서버 에러")})
+        }),
+})
 @RestController
 @RequestMapping("/users")
 @RequiredArgsConstructor