API docs - connect-foundation/2019-07 GitHub Wiki

API ๋ฌธ์„œ

ํ”„๋กœ์ ํŠธ์— ์‚ฌ์šฉํ•˜๋Š” API ๋ฌธ์„œ

API ๋ฌธ์„œ ์ œ์ž‘ ๊ฐ€์ด๋“œ๋ผ์ธ

API ๋Œ€ ๋ถ„๋ฅ˜

/url ๊ฒฝ๋กœ

API์˜ ๊ธฐ๋Šฅ์— ๋Œ€ํ•œ ์งค๋ง‰ํ•œ ์„ค๋ช…

method : get, post
request : {
    body : {
        key1 : value1 (type1)
        key2 : value2 (type2)
    }
}
response : {
    body : {
        key1 : value1 (type1)
        key2 : value2 (type2)
    }
    redirect : route1 || route2 || route3
}

API ์„ค๋ช…์— ๋Œ€ํ•œ ์ž์„ธํ•œ ์„ค๋ช…

์„ค๋ช…

method : api ์š”์ฒญ์„ ์–ด๋””๋กœ ํ•ด์•ผ ํ•˜๋Š”์ง€

body : request์—์„œ ๋“ค์–ด์˜ค๋Š” body ๊ฐ์ฒด, response์— sendํ•˜๋Š” ๊ฐ์ฒด์— ๋Œ€ํ•œ ์„ค๋ช…. ๋ฐ์ดํ„ฐ๋ฅผ ์—ฌ๋Ÿฌ๊ฐœ ๊ฐ€์งˆ ๊ฒฝ์šฐ ํ‚ค, ๊ฐ’, ํƒ€์ž…์„ ๊ธฐ์ˆ ํ•œ๋‹ค.

redirect : api์—์„œ redirect ์‹œํ‚ค๋Š” ๊ฒฝ์šฐ๋ฅผ ๊ธฐ์ˆ . ์ž์„ธํ•œ ์„ค๋ช…์€ ๋ณธ๋ฌธ์— ๊ธฐ์ˆ ํ•œ๋‹ค.

โš ๏ธ **GitHub.com Fallback** โš ๏ธ