송용우

Update API doc

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 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 | 바로가기 |
24 +| user | 유저 삭제 | DEELTE | api/user:id | 바로가기 |
25 +| user | 특정 유저 조회 | GET | api/user:id | 바로가기 |
26 +| user | 전체 유저 조회 | GET | api/user | 바로가기 |
27 +| friend | 유저 친구 등록 | POST | api/friend | 바로가기 |
28 +| friend | 유저의 친구 조회 | GET | api/friend:id | 바로가기 |
29 +| profile | 유저가 푼 문제 조회 | GET | api/profile/solved:id | 바로가기 |
30 +| auth | 로그인 | POST | api/auth/login | 바로가기 |
31 +| auth | 로그아웃 | GET | api/auth/logout | 바로가기 |
......