Spring REST Docs 설정을 추가하라 #32
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
yongjin5184
approved these changes
May 15, 2021
| @@ -0,0 +1,187 @@ | |||
| = Caregiver Salrong API Document | |||
|
|
||
| === HTTP Status | ||
|
|
||
| link:https://tools.ietf.org/html/rfc7231#section-6[RFC7231] 에 많은 HTTP 응답코드가 정의되어 있지만, 너무 많은 응답코드는 개발자에서 혼란을 초래한다. |
There was a problem hiding this comment.
토스 컨퍼런스에서 나온 이야기랑 똑같네요 ㅎ 인지하기 쉬운 응답만 사용한다. 💯
| |=== | ||
|
|
||
| NOTE: link:https://tools.ietf.org/html/rfc7231[RFC7231], link:https://ko.wikipedia.org/wiki/HTTP[위키백과] 에 근거하여 HTTP GET Method 에는 Request Body를 포함하지 않는다. | ||
| 이러한 이유로 인해 조회 성격의 API 이지만 조회 쿼리가 복잡할 경우 POST Method 를 사용할 수 있다. |
There was a problem hiding this comment.
어제 이거 관련해서 좀 찾아보다가 재미있는걸 찾았습니다.
가장 표를 많이 받은 글내용을 보면 GET 메서드에서 body를 사용해도된다라는 의견으로 이해가 되는데요.
@yongjin5184 님 의견은 어떠신가요?
| |=== | ||
| | Field | Type | Description | ||
|
|
||
| | `success` |
There was a problem hiding this comment.
성공여부를 body 에 내려주는 이유가 뭔지 여쭤봐도 될까요~? 🤔
Http Status 만으로는 판단하기 어려운 경우가 있나요~?
There was a problem hiding this comment.
네 맞아요 http status 로 만으로도 API 의 성공여부를 판단할 수 있습니다.
제가 success 필드를 추가한 이유는 클라이언트입장에서는 http status로 성공여부를 판단하는 거는
너무 많은 경우를 주는게 아닌가 라는 생각이 들어서 추가를 하였습니다.
@onemask 님 의견을 들어보면 좋을거같아요.
불필요한 필드라면 제거해도 좋습니다
|
해당 PR은 승인이 완료되었다고 판단되어 머지하도록 하겠습니다. |
truman-show
added a commit
that referenced
this pull request
May 15, 2021
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.
작업 내용
gradlew applications:client-api:clean applications:client-api:build명령어를 실행 후 생성된 jar 파일을 java -jar xxx.jar 로 실행 할 경우 아래 이미지를 확인 가능합니다.