유저 컨트롤러 문서화 완료 #96
Merged
유저 컨트롤러 문서화 완료 #96
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
- 단순히 메서드 명을 그대로 사용했었지만, 다른 컨트롤러테스트들에서도 전부 unique 해야 함을 파악
- entity명을 앞에 붙임으로써 메서드 명 추종을 가능하게 함
- 성공예시 외의 경우, "login - fail" 형식으로 "-" 뒤에 실패케이스 정보를 적어 성공예시("login")이 맨앞에 올 수 있도록 형식 통일
- 문서화를 위해 header 정보를 넣으려고 하자 실제 헤더에 없으면 안된다고 오류발생 - 따라서 직접 헤더에 token 생성하여 전달하도록 변경 - 기존의 @WithUserDetails는 삭제
리프레시 토큰 검사를 안하고 있던 큰 문제를 발견 및 수정
- 현재 사용하는 restdocs-api-spec은 multipart form data에 대한 parameter 문서화가 지원하지 않음 - 따라서 api description에 표로 해당 내용 직접 적음
sososo0
approved these changes
Oct 31, 2023
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.
Summary
유저 컨트롤러에 대한 문서화를 완료하였습니다.
문서화는 복사 붙여넣기가 많다보니까 PR 분량 조절이 너무 어려운거 같습니다... swagger로 결과물 확인하시는게 나을거 같습니다.
https://server.jagaldol.dev:8080/api/docs/swagger 제 개인 서버에 먼저 올려두었습니다. 여기서 현재까지의 api 문서화를 확인하실 수 있습니다.
Description
우여곡절이 많았는데, 일단 multipart/form-data의 경우 parameter 문서화가 안되서 직접 적었습니다.
그렇다고 하더라도 어떻게 전부 문서화 해놨고 쓸만한 거 같습니다.
저번에 이메일 보내는 테스트 mocking을 실패해서 주석 처리해놨었는데, 이것도 어떻게 해결하여 같이 문서화 하였습니다.
Related Issue
Issue Number: #63