Skip to content

Commit 1b5ccb5

Browse files
committed
docs: rest docs에 유저 로그인 문서화 추가
1 parent 280b325 commit 1b5ccb5

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

.github/workflows/develop_pull_request.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ jobs:
4040
4141
echo "${{ secrets.SCHEMA_SQL }}" | docker exec -i $TEST_POSTGRES_CONTAINER_NAME psql -U $TEST_POSTGRES_USER -d $TEST_POSTGRES_DB
4242
echo "${{ secrets.DATA_SQL }}" | docker exec -i $TEST_POSTGRES_CONTAINER_NAME psql -U $TEST_POSTGRES_USER -d $TEST_POSTGRES_DB
43+
44+
docker exec -i $TEST_POSTGRES_CONTAINER_NAME psql -U $TEST_POSTGRES_USER -d $TEST_POSTGRES_DB -c "SELECT * FROM users WHERE email='test@gmail.com';"
4345
4446
# Gradlew 실행 권한 허용
4547
- name: Grant Execute Permission for Gradlew

src/docs/asciidoc/index.adoc

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,8 @@ Content-Type: application/json
100100
| 공통 | 500 | INTERNAL_SERVER_ERROR | E500_001 | 서버 측에서 처리하지 못한 예외가 발생하면 모든 api 요청에 대해 공통적으로 반환됨.
101101
|===
102102

103+
104+
103105
== 회원
104106

105107
=== **1. 이메일 중복 확인**
@@ -142,3 +144,23 @@ include::{snippetsDir}/emailAuthentication/1/response-fields.adoc[]
142144
include::{snippetsDir}/emailAuthentication/2/http-response.adoc[]
143145
실패 2
144146
include::{snippetsDir}/emailAuthentication/3/http-response.adoc[]
147+
148+
149+
150+
== 인증/인가
151+
152+
=== **1. 유저 로그인**
153+
154+
유저 로그인 api 입니다. (이메일, 패스워드)
155+
156+
=== Request
157+
include::{snippetsDir}/loginUser/1/http-request.adoc[]
158+
159+
== 성공 Response
160+
include::{snippetsDir}/loginUser/1/http-response.adoc[]
161+
162+
== Response Body Fields
163+
include::{snippetsDir}/loginUser/1/response-fields.adoc[]
164+
165+
== 실패 Response
166+
include::{snippetsDir}/loginUser/2/http-response.adoc[]

0 commit comments

Comments
 (0)