From 176ae1c1e6c8b22773211f7f32456a24652c4671 Mon Sep 17 00:00:00 2001 From: kangyeson Date: Sun, 3 May 2026 04:11:43 +0900 Subject: [PATCH] =?UTF-8?q?[Feat]=20Swagger=20Docs=EC=97=90=20@Parameter?= =?UTF-8?q?=EB=A1=9C=20=EC=83=81=EC=84=B8=20=EC=84=A4=EB=AA=85=20=EC=B6=94?= =?UTF-8?q?=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../controller/CommentControllerDocs.java | 21 ++++++++++--------- .../post/controller/PostControllerDocs.java | 17 ++++++++------- .../controller/ReportControllerDocs.java | 6 ++++-- 3 files changed, 24 insertions(+), 20 deletions(-) diff --git a/src/main/java/com/example/leets7th/domain/comment/controller/CommentControllerDocs.java b/src/main/java/com/example/leets7th/domain/comment/controller/CommentControllerDocs.java index 13f0cd1e..c830ca86 100644 --- a/src/main/java/com/example/leets7th/domain/comment/controller/CommentControllerDocs.java +++ b/src/main/java/com/example/leets7th/domain/comment/controller/CommentControllerDocs.java @@ -4,6 +4,7 @@ import com.example.leets7th.domain.comment.dto.res.CommentResponseDTO; import com.example.leets7th.global.apiPayload.ApiResponse; import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.Parameter; import io.swagger.v3.oas.annotations.responses.ApiResponses; import io.swagger.v3.oas.annotations.tags.Tag; import jakarta.validation.Valid; @@ -26,8 +27,8 @@ public interface CommentControllerDocs { }) @GetMapping("/api/posts/{postId}/comments") ApiResponse> getCommentList( - @RequestHeader @Valid Long userId, - @PathVariable Long postId + @Parameter(description = "유저 ID", example = "1") @RequestHeader @Valid Long userId, + @Parameter(description = "게시글 ID", example = "1") @PathVariable Long postId ); @Operation( @@ -48,9 +49,9 @@ ApiResponse> getCommentList( }) @PatchMapping("/api/posts/{postId}/comments/{commentId}/adopt") ApiResponse adoptComment( - @RequestHeader @Valid Long userId, - @PathVariable Long postId, - @PathVariable Long commentId + @Parameter(description = "유저 ID", example = "1") @RequestHeader @Valid Long userId, + @Parameter(description = "게시글 ID", example = "1") @PathVariable Long postId, + @Parameter(description = "채택할 댓글 ID", example = "10") @PathVariable Long commentId ); @Operation( @@ -66,8 +67,8 @@ ApiResponse adoptComment( }) @PostMapping("/api/posts/{postId}/comments") ApiResponse createComment( - @RequestHeader @Valid Long userId, - @PathVariable Long postId, + @Parameter(description = "유저 ID", example = "1") @RequestHeader @Valid Long userId, + @Parameter(description = "게시글 ID", example = "1") @PathVariable Long postId, @RequestBody @Valid CommentRequestDTO.CreateCommentDTO request ); @@ -87,9 +88,9 @@ ApiResponse createComment( }) @PostMapping("/api/posts/{postId}/comments/{commentId}/replies") ApiResponse createReply( - @RequestHeader @Valid Long userId, - @PathVariable Long postId, - @PathVariable Long commentId, + @Parameter(description = "유저 ID", example = "1") @RequestHeader @Valid Long userId, + @Parameter(description = "게시글 ID", example = "1") @PathVariable Long postId, + @Parameter(description = "부모 댓글 ID", example = "10") @PathVariable Long commentId, @RequestBody @Valid CommentRequestDTO.CreateCommentDTO request ); } diff --git a/src/main/java/com/example/leets7th/domain/post/controller/PostControllerDocs.java b/src/main/java/com/example/leets7th/domain/post/controller/PostControllerDocs.java index 576d5a48..e2a2a67e 100644 --- a/src/main/java/com/example/leets7th/domain/post/controller/PostControllerDocs.java +++ b/src/main/java/com/example/leets7th/domain/post/controller/PostControllerDocs.java @@ -4,6 +4,7 @@ import com.example.leets7th.domain.post.dto.res.PostResponseDTO; import com.example.leets7th.global.apiPayload.ApiResponse; import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.Parameter; import io.swagger.v3.oas.annotations.responses.ApiResponses; import io.swagger.v3.oas.annotations.tags.Tag; import jakarta.validation.Valid; @@ -23,7 +24,7 @@ public interface PostControllerDocs { }) @GetMapping("/api/posts") ApiResponse> getPostList( - @RequestHeader @Valid Long userId + @Parameter(description = "유저 ID", example = "1") @RequestHeader @Valid Long userId ); @Operation( @@ -37,8 +38,8 @@ ApiResponse> getPostList( }) @GetMapping("/api/posts/{postId}") ApiResponse getPostDetail( - @PathVariable Long postId, - @RequestHeader @Valid Long userId + @Parameter(description = "게시글 ID", example = "1") @PathVariable Long postId, + @Parameter(description = "유저 ID", example = "1") @RequestHeader @Valid Long userId ); @Operation( @@ -54,7 +55,7 @@ ApiResponse getPostDetail( }) @PostMapping("/api/posts") ApiResponse createPost( - @RequestHeader @Valid Long userId, + @Parameter(description = "유저 ID", example = "1") @RequestHeader @Valid Long userId, @Valid @RequestBody PostRequestDTO.PostReqDTO req ); @@ -74,8 +75,8 @@ ApiResponse createPost( }) @PostMapping("/api/posts/{postId}") ApiResponse patchPost( - @PathVariable Long postId, - @RequestHeader @Valid Long userId, + @Parameter(description = "게시글 ID", example = "1") @PathVariable Long postId, + @Parameter(description = "유저 ID", example = "1") @RequestHeader @Valid Long userId, @Valid @RequestBody PostRequestDTO.PostReqDTO req ); @@ -92,7 +93,7 @@ ApiResponse patchPost( }) @PostMapping("/api/posts/{postId}") ApiResponse deletePost( - @PathVariable Long postId, - @RequestHeader @Valid Long userId + @Parameter(description = "게시글 ID", example = "1") @PathVariable Long postId, + @Parameter(description = "유저 ID", example = "1") @RequestHeader @Valid Long userId ); } diff --git a/src/main/java/com/example/leets7th/domain/report/controller/ReportControllerDocs.java b/src/main/java/com/example/leets7th/domain/report/controller/ReportControllerDocs.java index a88360be..fd6816ab 100644 --- a/src/main/java/com/example/leets7th/domain/report/controller/ReportControllerDocs.java +++ b/src/main/java/com/example/leets7th/domain/report/controller/ReportControllerDocs.java @@ -3,6 +3,7 @@ import com.example.leets7th.domain.report.dto.req.ReportReqDTO; import com.example.leets7th.global.apiPayload.ApiResponse; import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.Parameter; import io.swagger.v3.oas.annotations.responses.ApiResponses; import io.swagger.v3.oas.annotations.tags.Tag; import jakarta.validation.Valid; @@ -27,7 +28,7 @@ public interface ReportControllerDocs { }) @PostMapping("/api/report/{postId}") ApiResponse reportPost( - @RequestHeader @Valid Long userId, + @Parameter(description = "유저 ID", example = "1") @RequestHeader @Valid Long userId, @RequestBody @Valid ReportReqDTO.CreateReportDTO request ); @@ -41,5 +42,6 @@ ApiResponse reportPost( @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "REPORT404_1", description = "해당 게시글에 대한 신고가 존재하지 않습니다."), }) @PatchMapping("/api/admin/report/{postId}") - ApiResponse processReport(@PathVariable Long postId); + ApiResponse processReport( + @Parameter(description = "게시글 ID", example = "1") @PathVariable Long postId); }