-
Notifications
You must be signed in to change notification settings - Fork 3
api_spec
chlwlgus4 edited this page Nov 14, 2021
·
29 revisions
- ๊ฐ์
- ํ์ API
- ์นดํ ๊ณ ๋ฆฌ API
- ์ปค๋ฎค๋ํฐ ํผ๋ ๊ฒ์ํ API
-
์ฐ๋ฆผ์ฒญ ๊ตญ๋ฆฝ์๋ชฉ์_์๋ฌผ์์ ์๋น์ค API
- [์๋ฌผ ๋๊ฐ ๋ชฉ๋ก ๊ฒ์](#์๋ฌผ ๋๊ฐ ๋ชฉ๋ก ๊ฒ์)
- [์๋ฌผ ๋๊ฐ ์์ธ์ ๋ณด ์กฐํ](#์๋ฌผ ๋๊ฐ ์์ธ์ ๋ณด ์กฐํ)
- api ์คํ
- api: /user/signup
- http method: POST
- ์์ฒญ ํค๋
Content-Type: application/json;charset=UTF-8
- request_body
{
"email": "[email protected]",
"password": "password",
"nickname": "testuser"
}
- ์ฑ๊ณต ์๋ต
201 CREATED
{
"id": "1" ; ์์ฑ id
}
- api: /login
- http method: POST
- request_body: form-data
{
"email": "",
"password": ""
}
- ์ฑ๊ณต ์๋ต
- status_code: 200 OK
- cookie: ์ธ์ id๊ฐ JSESSIONID๋ก ๋ฆฌํด
- ์คํจ ์๋ต
- status_code: 401 Unauthorized
- api: /logout
- http method: POST
- ์์ฒญ ํค๋
Content-Type: application/json;charset=UTF-8
- request_body
{
}
- ์ฑ๊ณต ์๋ต
200 OK
- api: /category
- http method: GET
- ์์ฒญ ํค๋
Content-Type: application/json;charset=UTF-8
- api: /category
- http method: POST
- ์์ฒญ ํค๋
Content-Type: application/json;charset=UTF-8
cookie: "JESSIONID: <id>"
- request_body
{
"name": "",
"parentId": 0L
}
- api: /category/{category_id}
- http method: PUT
- ์์ฒญ ํค๋
Content-Type: application/json;charset=UTF-8
cookie: "JESSIONID: <id>"
- request_body
{
"name": "",
"parentId": ""
}
- api: /category/{category_id}
- http method: DELETE
- ์์ฒญ ํค๋
Content-Type: application/json;charset=UTF-8
cookie: "JESSIONID: <id>"
- api: /board
- http method: GET
- ์์ฒญ ํค๋
Content-Type: application/json;charset=UTF-8
- api: /board/{account_id}
- http method: GET
- ์์ฒญ ํค๋
Content-Type: application/json;charset=UTF-8
- api: /board/{board_id}
- http method: GET
- ์์ฒญ ํค๋
Content-Type: application/json;charset=UTF-8
- api: /board
- http method: POST
- ์์ฒญ ํค๋
Content-Type: application/json;charset=UTF-8
cookie: "JESSIONID: <id>"
- request_body
{
"content": "",
"account": {}
}
- api: /board/{board_id}
- http method: PUT
- ์์ฒญ ํค๋
Content-Type: application/json;charset=UTF-8
cookie: "JESSIONID: <id>"
- request_body
{
"content": "",
}
- api: /board/{board_id}
- http method: DELETE
- ์์ฒญ ํค๋
Content-Type: application/json;charset=UTF-8
cookie: "JESSIONID: <id>"
- api: /plntIlstrSearch
- request_body
{
"st": "1",
"sw": "",
"numOfRows": "10",
"pageNo": "1"
}
- api: /plntIlstrInfo?q1=?
- request_heder ๋๊ฐ๋ฒํธ