Skip to content

Commit

Permalink
docs: 로그인 API Error Response 추가 #121
Browse files Browse the repository at this point in the history
  • Loading branch information
chaewss committed Apr 24, 2024
1 parent 61e9ba3 commit 276a63c
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions src/docs/asciidoc/api-doc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,15 @@ include::{snippets}/auth-controller-test/respond_200_when_login_succeed/http-req
include::{snippets}/auth-controller-test/respond_200_when_login_succeed/response-fields.adoc[]
==== Sample Response
include::{snippets}/auth-controller-test/respond_200_when_login_succeed/http-response.adoc[]
==== Error Response
|===
| HTTP Status | Error Code | Detail

| `401 UNAUTHORIZED` | `INVALID_PASSWORD` | 비밀번호가 일치하지 않는 경우
| `403 FORBIDDEN` | `FORBIDDEN_USER` | 탈퇴한 회원인 경우
| `404 NOT FOUND` | `NOT_FOUND_USER` | 해당하는 아이디를 가진 사용자가 없는 경우
|===

=== 2-2. 로그아웃
==== Request Headers
include::{snippets}/auth-controller-test/respond_200_when_succeed_to_logout/request-headers.adoc[]
Expand All @@ -202,6 +211,7 @@ include::{snippets}/auth-controller-test/respond_200_when_succeed_to_logout/requ
include::{snippets}/auth-controller-test/respond_200_when_succeed_to_logout/http-request.adoc[]
==== Sample Response
include::{snippets}/auth-controller-test/respond_200_when_succeed_to_logout/http-response.adoc[]

=== 2-3. 토큰 재발급
==== Request Headers
include::{snippets}/auth-controller-test/respond_200_when_succeed_to_reissue_tokens/request-headers.adoc[]
Expand Down

0 comments on commit 276a63c

Please sign in to comment.