Showing
2 changed files
with
38 additions
and
1 deletions
1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. | 1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. |
2 | 2 | ||
3 | +# dotenv | ||
4 | +.env | ||
5 | + | ||
3 | # dependencies | 6 | # dependencies |
4 | -/node_modules | ||
... | \ No newline at end of file | ... | \ No newline at end of file |
7 | +/node_modules | ... | ... |
1 | +# Jaksimsamil API Documentation | ||
2 | + | ||
3 | +## Overview | ||
4 | + | ||
5 | +- TBA | ||
6 | + | ||
7 | +## URL | ||
8 | + | ||
9 | +- TBA | ||
10 | + | ||
11 | +## Usage | ||
12 | + | ||
13 | +- TBA | ||
14 | + | ||
15 | +## Example | ||
16 | + | ||
17 | +- TBA | ||
18 | + | ||
19 | +## API Table | ||
20 | + | ||
21 | +| group | description | method | URL | Detail | Auth | | ||
22 | +| ------- | ------------------------ | ------ | -------------------------- | -------- | --------- | | ||
23 | +| user | 유저 등록 | POST | api/user | 바로가기 | JWT Token | | ||
24 | +| user | 유저 삭제 | DEELTE | api/user:id | 바로가기 | JWT Token | | ||
25 | +| user | 특정 유저 조회 | GET | api/user:id | 바로가기 | None | | ||
26 | +| user | 전체 유저 조회 | GET | api/user | 바로가기 | JWT Token | | ||
27 | +| friend | 유저 친구 등록 | POST | api/friend | 바로가기 | JWT Token | | ||
28 | +| friend | 유저의 친구 조회 | GET | api/friend:id | 바로가기 | None | | ||
29 | +| profile | 유저가 푼 문제 조회 | GET | api/profile/solved:id | 바로가기 | None | | ||
30 | +| profile | 유저가 푼 문제 개수 조회 | GET | api/profile/solvednum:id | 바로가기 | None | | ||
31 | +| profile | 추천 문제 조회 | GET | api/profile/recommendps:id | 바로가기 | None | | ||
32 | +| notify | 슬랙 메시지 전송 요청 | POST | api/notify/slack | 바로가기 | Jwt Token | | ||
33 | +| auth | 로그인 | POST | api/auth/login | 바로가기 | None | | ||
34 | +| auth | 로그아웃 | GET | api/auth/logout | 바로가기 | JWT Token | | ... | ... |
-
Please register or login to post a comment