Skip to content

Commit c60ee13

Browse files
committed
docs: APPLE 로그인 API문서를 작성한다
1 parent b79a421 commit c60ee13

2 files changed

Lines changed: 25 additions & 1 deletion

File tree

docs/api/identity/get_user_by_token.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
"id": "1",
1616
"username": "devxb",
1717
"points": "491128",
18-
"profileImage": "https://avatars.githubusercontent.com/u/62425964?v=4"
18+
"profileImage": "https://avatars.githubusercontent.com/u/62425964?v=4",
19+
"entryPoint": "GITHUB" // GITHUB OR APPLE
1920
}
2021
```

docs/api/identity/login-apple.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# APPLE login
2+
3+
## Request
4+
### HTTP METHOD : `POST`
5+
### url : `https://api.gitanimals.org/logins/oauth/apple`
6+
### Header
7+
- Redirect-When-Success : `HOME`, `ADMIN`, `LOCAL`, `LOCAL_ADMIN` 중 하나를 입력해주세요. HOME은 로그인 성공시 홈페이지로 로그인, ADMIN은 로그인 성공시 어드민 페이지로 리다이렉트 됩니다. LOCAL은 `http://localhost:3000?jwt={jwt}` 로 리다이렉트 됩니다.
8+
- Login-Secret: 내부 로그인 토큰을 전달 하세요.
9+
10+
### Request Body
11+
```json
12+
{
13+
"name": "유저의 이름",
14+
"profileImage": "유저의 프로필 이미지"
15+
}
16+
```
17+
18+
# Response
19+
로그인 성공시 등록한 url로 jwt를 전달합니다.
20+
ADMIN : `https://admin.gitanimals.org?jwt={jwtToken}`
21+
HOME : `https://www.gitanimals.org?jwt={jwtToken}`
22+
LOCAL : `http://localhost:3000?jwt={jwtToken}`
23+
LOCAL_ADMIN : `http://localhost:5173?jwt={jwtToken}`

0 commit comments

Comments
 (0)