Skip to content

Commit

Permalink
docs: 리뷰 그룹 api를 위한 swagger 어노테이션 추가
Browse files Browse the repository at this point in the history
  • Loading branch information
Kimprodp committed Aug 8, 2024
1 parent 253ace5 commit c52f4a1
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 3 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
package reviewme.reviewgroup.controller;

import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.responses.ApiResponses;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.validation.Valid;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestBody;
import reviewme.reviewgroup.dto.ReviewGroupCreationRequest;
import reviewme.reviewgroup.dto.ReviewGroupCreationResponse;

@Tag(name = "리뷰 그룹 관리")
public interface ReviewGroupApi {

String APPLICATION_JSON = "application/json";

@Operation(summary = "리뷰 그룹 생성", description = "리뷰 그룹 정보를 받아 리뷰 그룹을 생성한다.")
@ApiResponses(value ={
@ApiResponse(
responseCode = "200",
description = "응답 성공 : 리뷰 그룹 생성",
content = @Content(
mediaType = APPLICATION_JSON,
schema = @Schema(implementation = ReviewGroupCreationRequest.class)
)
)
})
ResponseEntity<ReviewGroupCreationResponse> createReviewGroup(
@Valid @RequestBody ReviewGroupCreationRequest request
);
}
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

@RestController
@RequiredArgsConstructor
public class ReviewGroupController {
public class ReviewGroupController implements ReviewGroupApi {

private final ReviewGroupService reviewGroupService;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import io.swagger.v3.oas.annotations.media.Schema;
import jakarta.validation.constraints.NotBlank;

@Schema(description = "리뷰 그룹 생성 요청")
@Schema(name = "리뷰 그룹 생성 요청")
public record ReviewGroupCreationRequest(

@Schema(description = "리뷰이 이름", maxLength = 50)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import io.swagger.v3.oas.annotations.media.Schema;

@Schema(description = "리뷰 그룹 생성 완료 응답")
@Schema(name = "리뷰 그룹 생성 완료 응답")
public record ReviewGroupCreationResponse(

@Schema(description = "리뷰 요청 코드")
Expand Down

0 comments on commit c52f4a1

Please sign in to comment.