[Docs] 마이페이지 API REST Docs 작성 #107
Merged
Conversation
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
2 tasks
jwooo
reviewed
May 23, 2024
Comment on lines
24
to
97
| public class RatingControllerDocsTest extends RestDocsSupport { | ||
|
|
||
| private final RatingService ratingService = mock(RatingService.class); | ||
|
|
||
| @Override | ||
| protected Object initController() { | ||
| return new RatingController(ratingService); | ||
| } | ||
|
|
||
| @DisplayName("별점 생성 API") | ||
| @Test | ||
| void createRating() throws Exception { | ||
| RatingCreateRequest request = RatingCreateRequest.builder() | ||
| .bookIsbn("00000001") | ||
| .rating("3.5") | ||
| .build(); | ||
|
|
||
| mockMvc.perform( | ||
| post("/v1/ratings") | ||
| .content(objectMapper.writeValueAsString(request)) | ||
| .contentType(MediaType.APPLICATION_JSON) | ||
| ) | ||
| .andDo(print()) | ||
| .andExpect(status().isOk()) | ||
| .andDo(document("rating/create", | ||
| preprocessRequest(prettyPrint()), | ||
| preprocessResponse(prettyPrint()), | ||
| requestFields( | ||
| fieldWithPath("bookIsbn").type(JsonFieldType.STRING) | ||
| .description("책 isbn"), | ||
| fieldWithPath("rating").type(JsonFieldType.STRING) | ||
| .description("별점") | ||
| ), | ||
| responseFields( | ||
| fieldWithPath("code").type(JsonFieldType.NUMBER) | ||
| .description("코드"), | ||
| fieldWithPath("status").type(JsonFieldType.STRING) | ||
| .description("상태"), | ||
| fieldWithPath("message").type(JsonFieldType.STRING) | ||
| .description("메시지"), | ||
| fieldWithPath("data").type(JsonFieldType.NULL) | ||
| .description("return data null") | ||
| ) | ||
| )); | ||
| } | ||
|
|
||
| @DisplayName("별점 삭제 API") | ||
| @Test | ||
| void deleteRating() throws Exception { | ||
| mockMvc.perform( | ||
| delete("/v1/ratings/{ratingId}", 1) | ||
| .contentType(MediaType.APPLICATION_JSON) | ||
| ) | ||
| .andDo(print()) | ||
| .andExpect(status().isOk()) | ||
| .andDo(document("rating/delete", | ||
| preprocessRequest(prettyPrint()), | ||
| preprocessResponse(prettyPrint()), | ||
| pathParameters( | ||
| parameterWithName("ratingId") | ||
| .description("별점 ID") | ||
| ), | ||
| responseFields( | ||
| fieldWithPath("code").type(JsonFieldType.NUMBER) | ||
| .description("코드"), | ||
| fieldWithPath("status").type(JsonFieldType.STRING) | ||
| .description("상태"), | ||
| fieldWithPath("message").type(JsonFieldType.STRING) | ||
| .description("메시지"), | ||
| fieldWithPath("data").type(JsonFieldType.NULL) | ||
| .description("return data null") | ||
| ) | ||
| )); | ||
| } |
There was a problem hiding this comment.
RatingControllerDocsTest 에 @PatchMapping 테스트가 누락된 거 같습니다!
AHNYUNKI
approved these changes
May 23, 2024
jwooo
approved these changes
May 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
💡 연관된 이슈
close #101
📝 작업 내용
해당 API 추가하고 REST Docs도 작성했습니다.
💬 리뷰 요구 사항
궁금한 점 있으시면 코멘트 남겨주세요 !