Skip to content
Jihyun247 edited this page Mar 13, 2021 · 80 revisions

baseURL : 15.164.67.58:3000

API LIST

์œ ์ €๊ด€๋ฆฌ

url method ๊ธฐ๋Šฅ
/users/signup POST ํšŒ์›๊ฐ€์ž…
/users/signin POST ๋กœ๊ทธ์ธ
/users GET ๋‹‰๋„ค์ž„ ์ค‘๋ณต ๊ฒ€์‚ฌ
/users/fb-token POST ํŒŒ์ด์–ด๋ฒ ์ด์Šค ํ† ํฐ ๋“ฑ๋ก

ํ™ˆ

url method ๊ธฐ๋Šฅ
/home/public PUT ๊ณต๊ฐœ ์—ฌ๋ถ€ ์ˆ˜์ •
/home/all/:page GET ๋‹ต๋ณ€ ์ •๋ณด ๊ฐ€์ ธ์˜ค๊ธฐ
/home GET ์ƒˆ๋กœ์šด ์งˆ๋ฌธ ๋” ๋ฐ›๊ธฐ
/home/:answerId GET ์งˆ๋ฌธ ๋ณ€๊ฒฝํ•˜๊ธฐ
/home/:answerId DELETE ๋‹ต๋ณ€ ์‚ญ์ œํ•˜๊ธฐ

๋‹ต๋ณ€

url method ๊ธฐ๋Šฅ
/answers POST ๋‹ต๋ณ€ ๋“ฑ๋กํ•˜๊ธฐ
/answers PUT ๋‹ต๋ณ€ ์ˆ˜์ •ํ•˜๊ธฐ
/answers/detail/:answer_id GET ๋‹ต๋ณ€ ์ƒ์„ธ ํŽ˜์ด์ง€ ๊ฐ€์ ธ์˜ค๊ธฐ

ํƒ์ƒ‰

url method ๊ธฐ๋Šฅ
/exploration/?page&category&sorting GET ๋‹ค๋ฅธ๊ธ€ ๋‘˜๋Ÿฌ๋ณด๊ธฐ (์ธ๊ธฐ/์ตœ์‹ )
/exploration/:questionId?page&sorting GET ํ•œ ์งˆ๋ฌธ์— ๋Œ€ํ•œ ๋‹ต๋ณ€ ๋ชจ์•„๋ณด๊ธฐ (์ธ๊ธฐ/์ตœ์‹ )
/exploration/another GET ''๋‚˜์™€ ๋‹ค๋ฅธ ์ƒ๊ฐ๋“ค'' ๋‹ต๋ณ€ 7๊ฐœ ๊ฐ€์ ธ์˜ค๊ธฐ
/exploration/:answerId PUT ๋‹ต๋ณ€ ์Šคํฌ๋žฉํ•˜๊ธฐ / ์Šคํฌ๋žฉ ์ทจ์†Œํ•˜๊ธฐ
/exploration/category GET ์นดํ…Œ๊ณ ๋ฆฌ ๋ฆฌ์ŠคํŠธ ๊ฐ€์ ธ์˜ค๊ธฐ
/exploration/answer GET ์ตœ์ดˆ ๋‹ต๋ณ€ํ•˜๋Ÿฌ ๊ฐ€๊ธฐ

ํƒ์ƒ‰ํƒญ Sorting ์‚ญ์ œ ๋ฐ page_len ์‚ญ์ œ API (๋‹ค๋ฅธ๊ธ€ ๋‘˜๋Ÿฌ๋ณด๊ธฐ & ํ•œ ์งˆ๋ฌธ์— ๋Œ€ํ•œ ๋‹ต๋ณ€ ๋ชจ์•„๋ณด๊ธฐ)

url method ๊ธฐ๋Šฅ
/exploration/all/?page&category GET ๋‹ค๋ฅธ๊ธ€ ๋‘˜๋Ÿฌ๋ณด๊ธฐ (new)
/exploration/all/:questionId?page&sorting GET ํ•œ ์งˆ๋ฌธ์— ๋Œ€ํ•œ ๋‹ต๋ณ€ ๋ชจ์•„๋ณด๊ธฐ (new)

๋Œ“๊ธ€

url method ๊ธฐ๋Šฅ
/answers/comments POST ๋Œ“๊ธ€ ๋“ฑ๋กํ•˜๊ธฐ
/answers/comments PUT ๋Œ“๊ธ€ ์ˆ˜์ •ํ•˜๊ธฐ
/answers/comments/:comment_id DELETE ๋Œ“๊ธ€ ์‚ญ์ œํ•˜๊ธฐ

ํŒ”๋กœ์ž‰

url method ๊ธฐ๋Šฅ
/follow GET ํŒ”๋กœ์›Œ, ํŒ”๋กœ์ด ๋ฆฌ์ŠคํŠธ ๊ฐ€์ ธ์˜ค๊ธฐ
/follow PUT ํŒ”๋กœ์ž‰ํ•˜๊ธฐ, ํŒ”๋กœ์ž‰ ์ทจ์†Œํ•˜๊ธฐ
/follow/answers?category&page GET ํŒ”๋กœ์ด, ํŒ”๋กœ์›Œ ๊ณต๊ฐœ ๋‹ต๋ณ€ ๊ฐ€์ ธ์˜ค๊ธฐ
/follow/:user_id DELETE ํŒ”๋กœ์›Œ ์‚ญ์ œํ•˜๊ธฐ
/answers/question POST ๋‹ต๋ณ€ ์ƒ์„ฑํ•˜๊ธฐ

์•„์ด๋”” ๊ฒ€์ƒ‰

url method ๊ธฐ๋Šฅ
/users/search?query&range GET ์•„์ด๋”” ๊ฒ€์ƒ‰ํ•˜๊ธฐ
/users/search/history GET ์ตœ๊ทผ ์•„์ด๋”” ๊ฒ€์ƒ‰ ๊ธฐ๋ก ๊ฐ€์ ธ์˜ค๊ธฐ
/users/search/:searchId DELETE ์ตœ๊ทผ ์•„์ด๋”” ๊ฒ€์ƒ‰ ๊ธฐ๋ก ์‚ญ์ œ

์•Œ๋ฆผ

url method ๊ธฐ๋Šฅ
/users/activities GET ์ตœ๊ทผ ํ™œ๋™ ๊ฐ€์ ธ์˜ค๊ธฐ

๋งˆ์ดํŽ˜์ด์ง€

url method ๊ธฐ๋Šฅ
/profiles/answers/:user_id GET ํƒ€์ธ์ด ์“ด ๊ธ€ ๊ฐ€์ ธ์˜ค๊ธฐ
/profiles/:user_id GET ํƒ€์ธ ํ”„๋กœํ•„ ๊ฐ€์ ธ์˜ค๊ธฐ
/profiles/answers?public=String&category=Int&page=Int&query=String GET ๋งˆ์ดํŽ˜์ด์ง€ ๋‚ด๊ฐ€ ์“ด ๊ธ€ ๊ฐ€์ ธ์˜ค๊ธฐ
/profiles GET ๋งˆ์ดํŽ˜์ด์ง€ ํ”„๋กœํ•„ ๊ฐ€์ ธ์˜ค๊ธฐ
/profiles/scraps?public=String&category=Int&page=Int&query=String GET ๋งˆ์ดํŽ˜์ด์ง€ ์Šคํฌ๋žฉ ๊ฐ€์ ธ์˜ค๊ธฐ
/profiles PUT ํ”„๋กœํ•„ ์‚ฌ์ง„ ๋ณ€๊ฒฝ

์—๋Ÿฌ์ฝ”๋“œ

Integer ์ฝ”๋“œ(statusCode) ์™€ String ๋ฉ”์„ธ์ง€(responseMessage) ๋กœ ๊ตฌ์„ฑ

์˜ˆ์‹œ :

{
    "status" : 401,
    "success" : false
    "message": "์œ ํšจํ•˜์ง€ ์•Š์€ ํ† ํฐ์ž…๋‹ˆ๋‹ค"
}

๊ณตํ†ต

status message ์„ค๋ช…
400 ํ•„์š”ํ•œ ๊ฐ’์ด ์—†์Šต๋‹ˆ๋‹ค ํ•„์ˆ˜ ํŒŒ๋ผ๋ฏธํ„ฐ๊ฐ€ ์—†์„ ๋•Œ
400 ํŒŒ๋ผ๋ฏธํ„ฐ ๊ฐ’์ด ์ž˜๋ชป ๋˜์—ˆ์Šต๋‹ˆ๋‹ค ํŒŒ๋ผ๋ฏธํ„ฐ๊ฐ€ ์กด์žฌํ•˜์ง€๋งŒ ์ž˜๋ชป ์ „๋‹ฌํ–ˆ์„ ๋–„
401 ํ† ํฐ ๊ฐ’์ด ์—†์Šต๋‹ˆ๋‹ค header ์— ํ† ํฐ ๊ฐ’์ด ์กด์žฌํ•˜์ง€ ์•Š์„ ๋•Œ
401 ํ† ํฐ ๊ฐ’์ด ๋งŒ๋ฃŒ๋˜์—ˆ์Šต๋‹ˆ๋‹ค ํ† ํฐ ๊ฐ’์˜ ๊ธฐํ•œ์ด ๋งŒ๋ฃŒ๋˜์—ˆ์„ ๋•Œ

ํšŒ์›๊ฐ€์ž…

status message ์„ค๋ช…
400 ์กด์žฌํ•˜๋Š” {parameter} ์ž…๋‹ˆ๋‹ค {parameter} ๊ฐ€ ์ด๋ฏธ db์— ์กด์žฌํ•  ๋•Œ

๋กœ๊ทธ์ธ

status message ์„ค๋ช…
400 ์กด์žฌํ•˜์ง€ ์•Š๋Š” ์œ ์ €์ž…๋‹ˆ๋‹ค nickname์— ํ•ด๋‹นํ•˜๋Š” ์œ ์ €๊ฐ€ ์กด์žฌํ•˜์ง€ ์•Š์Œ
400 ๋น„๋ฐ€๋ฒˆํ˜ธ๊ฐ€ ์ผ์น˜ํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค

๋‹ต๋ณ€

status message ์„ค๋ช…
400 ์กด์žฌํ•˜์ง€ ์•Š๋Š” ์œ ์ € id ์ž…๋‹ˆ๋‹ค
400 ์ด๋ฏธ ๋‹ต๋ณ€์ด ๋“ฑ๋ก๋œ ์งˆ๋ฌธ์ž…๋‹ˆ๋‹ค
400 ์กด์žฌํ•˜์ง€ ์•Š๋Š” ๋‹ต๋ณ€ id ๊ฐ’์ž…๋‹ˆ๋‹ค ์กด์žฌํ•˜์ง€ ์•Š๋Š” ๋‹ต๋ณ€ id ๊ฐ’ (ํ•ด๋‹น ์œ ์ €๊ฐ€ ์ˆ˜์ •/๋“ฑ๋ก ๋ถˆ๊ฐ€๋Šฅํ•œ ๋‹ต๋ณ€์ผ ๊ฒฝ์šฐ์—๋„)
400 ํ•ด๋‹น ์œ ์ €์—๊ฒŒ ๊ถŒํ•œ์ด ์—†์Šต๋‹ˆ๋‹ค ๋‹ค๋ฅธ ์‚ฌ๋žŒ์˜ unpublic ๋‹ต๋ณ€์— ์ ‘๊ทผํ•˜๋ ค๊ณ  ํ•  ๋•Œ

๋Œ“๊ธ€

status message ์„ค๋ช…
400 ์ž˜๋ชป๋œ parent_id ์ž…๋‹ˆ๋‹ค parent_id ์— ํ•ด๋‹นํ•˜๋Š” ๋Œ“๊ธ€์ด ์กด์žฌํ•˜์ง€ ์•Š๊ฑฐ๋‚˜, parent ๊ฐ€ ์•„๋‹Œ ๋Œ“๊ธ€์„ ์ง€์ •ํ•˜๊ณ  ์žˆ์„ ๋•Œ
400 ์กด์žฌํ•˜์ง€ ์•Š๋Š” ๋‹ต๋ณ€ id ๊ฐ’์ž…๋‹ˆ๋‹ค
400 ํ•ด๋‹น ์œ ์ €์—๊ฒŒ ๊ถŒํ•œ์ด ์—†์Šต๋‹ˆ๋‹ค ์ž์‹ ์˜ ๋Œ“๊ธ€์ด ์•„๋‹Œ ๋Œ“๊ธ€์„ ์ˆ˜์ •ํ•  ๋•Œ, ๋Œ€๋Œ“๊ธ€์„ ๋‹ฌ ๊ถŒํ•œ์ด ์—†์„ ๋•Œ
400 ์กด์žฌํ•˜์ง€ ์•Š๋Š” ๋Œ“๊ธ€ id ์ž…๋‹ˆ๋‹ค.

ํŒ”๋กœ์ž‰

status message ์„ค๋ช…
400 ์กด์žฌํ•˜์ง€์•Š๋Š” ์œ ์ € id ์ž…๋‹ˆ๋‹ค.
400 ์ž๊ธฐ ์ž์‹ ์€ ํŒ”๋กœ์šฐํ•  ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค ํŒ”๋กœ์ž‰ํ•˜๋ ค๋Š” id ๋กœ ์ž๊ธฐ ์ž์‹ ์˜ id ๋ฅผ ๋ณด๋‚ด์™”์„ ๋•Œ
400 ์ด๋ฏธ ํŒ”๋กœ์šฐํ•œ ์œ ์ €์ž…๋‹ˆ๋‹ค
400 ํŒ”๋กœ์›Œ๊ฐ€ ์•„๋‹™๋‹ˆ๋‹ค ํŒ”๋กœ์›Œ๊ฐ€ ์•„๋‹Œ ์‚ฌ๋žŒ์„ ํŒ”๋กœ์šฐ ์‚ญ์ œ ํ•  ๋•Œ

๋งˆ์ดํŽ˜์ด์ง€

status message ์„ค๋ช…
200 ์œ ์ €๊ฐ€ ์ž‘์„ฑํ•œ ๋‹ต๋ณ€์ด ์กด์žฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค ์œ ์ €๊ฐ€ ์ž‘์„ฑํ•œ ๋‹ต๋ณ€์ด ์กด์žฌํ•˜์ง€ ์•Š์„ ๋•Œ

์ „์ฒด API ๋กœ์ง ๊ตฌํ˜„ ์ง„์ฒ™๋„

4,5์ˆœ์œ„๋Š” ์•ฑ์žผ ํ›„

์Šคํฌ๋ฆฐ์ƒท 2021-01-05 ์˜คํ›„ 3 58 19 ์Šคํฌ๋ฆฐ์ƒท 2021-01-05 ์˜คํ›„ 4 00 00 ์Šคํฌ๋ฆฐ์ƒท 2021-01-05 ์˜คํ›„ 4 00 13
Clone this wiki locally