Api-blueprint: APIARY๋Š” ๋™์ผํ•œ ํ”„๋กœ์ ํŠธ์—์„œ ๋‹ค์ค‘ ํ˜ธ์ŠคํŠธ๋ฅผ ํ—ˆ์šฉํ•ฉ๋‹ˆ๊นŒ?

์— ๋งŒ๋“  2018๋…„ 03์›” 08์ผ  ยท  9์ฝ”๋ฉ˜ํŠธ  ยท  ์ถœ์ฒ˜: apiaryio/api-blueprint

์•ˆ๋…•,

๋™์ผํ•œ ํ”„๋กœ์ ํŠธ์— ๋‘ ๊ฐœ์˜ ํ˜ธ์ŠคํŠธ๋ฅผ ์ถ”๊ฐ€ํ•˜๋ ค๊ณ  ํ•ฉ๋‹ˆ๋‹ค.
ํ˜ธ์ŠคํŠธ 1 : https://abc.com/
ํ˜ธ์ŠคํŠธ 2 : https://efg.com/

ํ˜„์žฌ "HOST: https://abc.com "์„ ์‚ฌ์šฉํ•˜์—ฌ ํ•˜๋‚˜์˜ ํ˜ธ์ŠคํŠธ๋กœ ์ž‘์—…ํ•  ์ˆ˜ ์žˆ์ง€๋งŒ ๋™์ผํ•œ ํ”„๋กœ์ ํŠธ์— ๊ตฌ์„ฑ๋œ ๋‘ ๊ฐœ์˜ ํ˜ธ์ŠคํŠธ๊ฐ€ ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค. ๋™์ผํ•œ ํ”„๋กœ์ ํŠธ์—์„œ ๋‘ ๊ฐœ์˜ ํ˜ธ์ŠคํŠธ๋ฅผ ์ •์˜ํ•˜๋Š” ๋ฐฉ๋ฒ•์ด ์žˆ์Šต๋‹ˆ๊นŒ?

๋ฏธ๋ฆฌ ๊ฐ์‚ฌ๋“œ๋ฆฝ๋‹ˆ๋‹ค. ๋„์™€์ฃผ์„ธ์š”.

๋ฌธ์•ˆ ์ธ์‚ฌ,
ํ…Œ์ž

Apiary.io

๊ฐ€์žฅ ์œ ์šฉํ•œ ๋Œ“๊ธ€

์ด์— ๋Œ€ํ•œ ์—…๋ฐ์ดํŠธ๊ฐ€ ์žˆ์Šต๋‹ˆ๊นŒ?

๋ชจ๋“  9 ๋Œ“๊ธ€

์ด๊ฒƒ๋„ ๊ถ๊ธˆํ•ฉ๋‹ˆ๋‹ค. ์šฐ๋ฆฌ๋Š” ์—ฌ๋Ÿฌ ํ…Œ์ŠคํŠธ ํ™˜๊ฒฝ์„ ์‚ฌ์šฉํ•˜๊ณ  ์žˆ์œผ๋ฉฐ ์ฐจ์ด์ ์„ ์ฐพ๊ธฐ ์œ„ํ•ด ๋‘˜ ์‚ฌ์ด๋ฅผ ์ „ํ™˜ํ•  ์ˆ˜ ์žˆ๋Š” ๊ฒƒ์ด ์ค‘์š”ํ•ฉ๋‹ˆ๋‹ค.

ํ˜„์žฌ๋Š” ์ง€์›ํ•˜์ง€ ์•Š์ง€๋งŒ ํ–ฅํ›„ ์ด๋ฅผ ๊ฐ€๋Šฅํ•˜๊ฒŒ ํ•˜๋Š” ์†”๋ฃจ์…˜์„ ๊ฐœ๋ฐœ ์ค‘์ž…๋‹ˆ๋‹ค.

์ด์— ๋Œ€ํ•œ ์—…๋ฐ์ดํŠธ๊ฐ€ ์žˆ์Šต๋‹ˆ๊นŒ?

์ด ๋ฌธ์ œ์— ๋Œ€ํ•œ ํ•ด๊ฒฐ์ฑ…์ด ์ด๋ฏธ ์žˆ์Šต๋‹ˆ๊นŒ?

๊ณต๊ฐœ๊ฐ€ ์•„๋‹™๋‹ˆ๋‹ค. ์šฐ๋ฆฌ๋Š” ์ด ๋ฌธ์ œ๋ฅผ ํ•ด๊ฒฐํ•˜๋Š” ๋ฐฉ๋ฒ•์— ๋Œ€ํ•ด ๋ธŒ๋ ˆ์ธ์Šคํ† ๋ฐ์„ ํ•˜๊ณ  ์žˆ์œผ๋ฉฐ ์„ค๊ณ„ ๋ฐ ๋ฐฐํฌ ๋ฌธ์ œ๋ฅผ ๋ถ„๋ฆฌํ•˜๋Š” ๊ฒƒ๊ณผ ๋‹ฌ๋ฆฌ ์—ฌ๋Ÿฌ HOST๊ฐ€ ์˜ฌ๋ฐ”๋ฅธ ์†”๋ฃจ์…˜์ธ์ง€ ํ™•์‹ ํ•  ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค.

@Almad ์ด ๋ฌธ์ œ์™€ ๊ด€๋ จํ•˜์—ฌ ๋ช‡ ๊ฐ€์ง€ ํ”ผ๋“œ๋ฐฑ์„ ์ œ๊ณตํ•˜๊ธฐ ์œ„ํ•ด ์ œ ์‚ฌ์šฉ ์‚ฌ๋ก€๋ฅผ ์„ค๋ช…ํ•˜๊ฒ ์Šต๋‹ˆ๋‹ค.

Apiary ์‚ฌ์šฉ ์‚ฌ๋ก€๋Š” ์ˆœ์ „ํžˆ ๊ฐœ๋ฐœ์ž ๋Œ€์‹œ๋ณด๋“œ์— ์˜ˆ์œ ๋ฌธ์„œ๋ฅผ ํฌํ•จํ•˜๋Š” ๊ฒƒ์ž…๋‹ˆ๋‹ค. ์šฐ๋ฆฌ๋Š” ์ง€๊ธˆ ์ถ”๊ฐ€ ๊ธฐ๋Šฅ, ํ”Œ๋Ÿฌ๊ทธ์ธ ๋˜๋Š” ํ™•์žฅ์„ ์‚ฌ์šฉํ•  ๊ณ„ํš์ด ์—†์Šต๋‹ˆ๋‹ค. ์ธ์ฆ, ์ฒญ๊ตฌ, ํ†ต๊ณ„, ๋ฆฌ์†Œ์Šค ๊ฒ€์ƒ‰ ๋“ฑ๊ณผ ๊ฐ™์ด ์‹œ์Šคํ…œ์˜ ์—ฌ๋Ÿฌ ๋ถ€๋ถ„(๋งˆ์ดํฌ๋กœ ์„œ๋น„์Šค)์— ๋Œ€ํ•ด ์—ฌ๋Ÿฌ ํ•˜์œ„ ๋„๋ฉ”์ธ์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค. ๋ณด์‹œ๋‹ค์‹œํ”ผ ๊ฐ ํ•˜์œ„ ๋„๋ฉ”์ธ์€ ์„œ๋กœ ๋‹ค๋ฅธ ๋„๋ฉ”์ธ์„ ๋‹ด๋‹นํ•ฉ๋‹ˆ๋‹ค.

Apiary์—์„œ ๊ฐ€์žฅ ๋งค๋ ฅ์ ์œผ๋กœ ๋ณด์ด๋Š” ๊ฒƒ์€ ์ฝ˜์†” ๊ธฐ๋Šฅ์ž…๋‹ˆ๋‹ค. ๋์ ์„ ์„ค๋ช…ํ•  ์ˆ˜ ์žˆ๊ณ  ์ตœ์ข… ์‚ฌ์šฉ์ž๋Š” ์ฝ˜์†”์„ ํ†ตํ•ด ๋์ ์„ ์‹คํ—˜ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๋˜ํ•œ ์–ธ์–ด๋ฅผ ๋ณ€๊ฒฝํ•˜๊ณ  ๋‹ค๋ฅธ ์–ธ์–ด๋กœ ์˜ˆ์ œ ์ฝ”๋“œ๋ฅผ ๋ณต์‚ฌํ•˜๋Š” ์˜ต์…˜์„ ์ถ”๊ฐ€ํ•ฉ๋‹ˆ๋‹ค.

๊ทธ๋Ÿฌ๋‚˜ ์—ฌ๋Ÿฌ ํ•˜์œ„ ๋„๋ฉ”์ธ์„ ์‚ฌ์šฉํ•˜๋Š” ์˜ต์…˜์ด ์—†์œผ๋ฉด ๋ช‡ ๊ฐ€์ง€ ์˜ต์…˜๋งŒ ๋‚จ์Šต๋‹ˆ๋‹ค.

  • ๋งˆ์ดํฌ๋กœ ์„œ๋น„์Šค๋งˆ๋‹ค ๋‹ค๋ฅธ ๋ฌธ์„œ๋ฅผ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค. ๊ทธ๋Ÿฌ๋‚˜ ๋ฌธ์„œ๋Š” ์—ฌ๊ธฐ์ €๊ธฐ ํฉ์–ด์ ธ ์žˆ์Šต๋‹ˆ๋‹ค. ๋”ฐ๋ผํ•˜๊ธฐ ์–ด๋ ต์Šต๋‹ˆ๋‹ค. ๊ทธ๋ฆฌ๊ณ  ๊ทธ๋“ค ์‚ฌ์ด์˜ ์—ฐ๊ฒฐ์€ ์‚ฌ์†Œํ•œ ์ผ์ด ์•„๋‹™๋‹ˆ๋‹ค.
  • ์ฐธ์กฐ๋ฅผ ์ „ํ˜€ ์‚ฌ์šฉํ•˜์ง€ ๋งˆ์‹ญ์‹œ์˜ค. ๋ฌธ์„œ๋ฅผ ํฌํ•จํ•˜๋Š” ๋™์•ˆ ์ฝ˜์†”์„ ์ˆจ๊น๋‹ˆ๋‹ค. ๋‹จ์ ์€ ๋ฌผ๋ก  ์ฝ˜์†”์„ ํ‘œ์‹œํ•˜์ง€ ์•Š๋Š”๋‹ค๋Š” ๊ฒƒ์ž…๋‹ˆ๋‹ค. ๊ทธ๋Ÿฐ ๋‹ค์Œ ๋‹ค์Œ ๊ธ€๋จธ๋ฆฌ ๊ธฐํ˜ธ๋ฅผ ์ƒ๊ฐํ•˜๊ฒŒ ๋ฉ๋‹ˆ๋‹ค.
  • API ๋ฌธ์„œ ์ž‘์„ฑ์€ ํƒ€์‚ฌ๋ฅผ ์‚ฌ์šฉํ•˜์ง€ ์•Š๊ณ  ์Šค์Šค๋กœ ์„ค๊ณ„ํ•ฉ๋‹ˆ๋‹ค.

์–ด๋–ค ์˜ต์…˜๋„ ํ›Œ๋ฅญํ•ด ๋ณด์ด์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ์šฐ๋ฆฌ์˜ ๊ฒฝ์šฐ์— ์–ด๋–ค ์ถ”์ฒœ์ด ์žˆ์Šต๋‹ˆ๊นŒ?

๊ทธ๊ฒƒ์— ๋Œ€ํ•œ ํ•ด๊ฒฐ์ฑ…์ด ์žˆ์„ ๊ฒƒ์ด์ง€๋งŒ ๋ถˆํ–‰ํžˆ๋„ SEC์™€ ๋ณ€ํ˜ธ์‚ฌ ๋•Œ๋ฌธ์— ๊ทธ๊ฒƒ์— ๋Œ€ํ•ด ์ด์•ผ๊ธฐํ•˜๊ณ  ์ผ์ •์„ ๋งํ•  ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค.

๊ฐ€๊นŒ์šด ๋ฏธ๋ž˜๊ฐ€ ์ถฉ๋ถ„ํ•œ ํฌ๋ง์„ ์ค„ ์ˆ˜ ์žˆ์Šต๋‹ˆ๊นŒ?

์–ด๋–ค ์ง„์ „์ด ์žˆ์Šต๋‹ˆ๊นŒ?

host ๊ฐœ์ฒด์— ๋Œ€ํ•œ ์ง€์›์€ ์ฃผ๋กœ OAS3 ์„œ๋ฒ„ ๊ฐœ์ฒด ๋งคํ•‘์„ ์ง€์›ํ•˜๊ธฐ ์œ„ํ•ด API ์š”์†Œ ์— https://help.apiary.io/tools/interactive-documentation-v4/ ๋ Œ๋”๋Ÿฌ ์—…๋ฐ์ดํŠธ๋ฅผ ๊ณ„์† ์ง€์ผœ๋ด ์ฃผ์‹ญ์‹œ์˜ค.

ํ•˜์ง€๋งŒ API Blueprint์—์„œ ์ง€์›์— ๋Œ€ํ•œ ์ง„ํ–‰ ์ƒํ™ฉ์„ ๋ณด์ง€ ๋ชปํ–ˆ์Šต๋‹ˆ๋‹ค.

์ด ํŽ˜์ด์ง€๊ฐ€ ๋„์›€์ด ๋˜์—ˆ๋‚˜์š”?
0 / 5 - 0 ๋“ฑ๊ธ‰