-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: 리뷰 그룹 api를 위한 swagger 어노테이션 추가
- Loading branch information
Showing
4 changed files
with
37 additions
and
3 deletions.
There are no files selected for viewing
34 changes: 34 additions & 0 deletions
34
backend/src/main/java/reviewme/reviewgroup/controller/ReviewGroupApi.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters