[feat] : 테스트 코드를 수정하여 REST Docs에 설명을 추가한다 #60
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
bbbang105
added
🚀 feat
juuuunny
approved these changes
Nov 8, 2024
There was a problem hiding this comment.
문서화 시 더 상세하게 적어주는 것 좋네요.
전 최대한 간단히 적었었긴 한데 문서화해서 클라이언트측에 보여줄 때 더 이해하기도 쉽고 좋을 것 같아서
저도 나중에 추가할 때 더 상세히 문서화 해야겠어요.
| "포토카드", | ||
| List.of("선수들의 사진을 뽑을 수 있는 포토카드! 경기 시작 전에 포토카드 기계로 가서 포토카드를 뽑을 수 있어요."), | ||
| List.of("기계의 QR을 통해 원하는 선수나, 자신의 사진으로 커스텀 포토카드를 뽑을 수 있으니 참고하세요!") | ||
| ); | ||
| GetEntertainmentsResponseDto getEntertainmentsResponseDto = GetEntertainmentsResponseDto.of(List.of(entertainmentDto)); |
There was a problem hiding this comment.
아 여기 테스트코드에서는 줄바꿈을 안햇었네요!!
나중에 추가적으로 하는 부분에선 좀 더 신경쓰겠습니다!
| fieldWithPath("payload.entertainments[].boundary").type(JsonFieldType.STRING).description("해당 즐길거리의 영역 (내부 or 외부)"), | ||
| fieldWithPath("payload.entertainments[].name").type(JsonFieldType.STRING).description("해당 즐길거리의 이름"), | ||
| fieldWithPath("payload.entertainments[].explanations[]").type(JsonFieldType.ARRAY).description("해당 즐길거리의 설명 리스트"), | ||
| fieldWithPath("payload.entertainments[].tips[]").type(JsonFieldType.ARRAY).description("해당 즐길거리의 팁 리스트") | ||
| ) |
There was a problem hiding this comment.
.type(JsonFieldType.BOOLEAN) 이거를 통해서 클라이언트측에 타입을 알려줄 수 있는건가요???
There was a problem hiding this comment.
이거 없어도 타입 자체는 알아서 지정되는 것 같기는 해요!
다만 이제 테스트를 할 때 타입까지 고려해서 좀 더 상세하게 할 수 있다..? 정도인 것 같고
저는 첨부터 썼어가지고 이번 기회로 통일했습니다!
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.
✅ PR 유형
어떤 변경 사항이 있었나요?
📝 작업 내용
이번 PR에서 작업한 내용을 간략히 설명해주세요(이미지 첨부 가능)
기존 스키마 (스키마명 & 설명 커스텀 X)
변경 후 스키마
쿼리 파라미터 예시 및 타입 설명 추가
✏️ 관련 이슈
본인이 작업한 내용이 어떤 Issue Number와 관련이 있는지만 작성해주세요
🎸 기타 사항 or 추가 코멘트