API documentation

์ฃผ์„ ๋ถ„์„๊ธฐ๋ฅผ ์ด์šฉํ•œ ๊ฐ„๋‹จํ•œ API ๋ฌธ์„œํ™” ๋ฐฉ๋ฒ•

ํ…Œํฌ๋‹ˆ์ปฌ ๋ผ์ดํ„ฐ๋กœ์„œ ๊ฐ€์žฅ ์žฌ๋ฏธ์žˆ๋Š” ์ˆœ๊ฐ„์€ ๋ฐ”๋กœ ์ƒˆ๋กœ์šด ํ”„๋กœ์ ํŠธ๋ฅผ ์‹œ์ž‘ํ•  ๋•Œ์ž…๋‹ˆ๋‹ค. ํ”„๋กœ์ ํŠธ๋ฅผ ์‹œ์ž‘ํ•˜๋Š” ์ˆœ๊ฐ„์—๋Š” ๋ชจ๋“  ๊ฒƒ์ด ์—ด๋ ค ์žˆ์–ด ์ž์œ ๋กœ์šฐ๋ฉฐ, ๊ทธ ์ž์œ ๊ฐ€ ์ƒˆ๋กœ์šด ๋„๋ฉ”์ธ์— ๋Œ€ํ•œ ํƒ๊ตฌ์‹ฌ์„ ์ž๊ทนํ•˜๊ธฐ ๋•Œ๋ฌธ์ž…๋‹ˆ๋‹ค. ๊ทธ๋Ÿฐ ์ ์—์„œ ์งง์ง€๋งŒ ๊ตต๊ฒŒ ์ƒˆ๋กœ์šด ๊ฒƒ์„ ์‹œ๋„ํ•˜๊ณ  ๋ฐฐ์šธ ์ˆ˜ ์žˆ๋Š” ๊ธฐ์ˆ  ๋ฌธ์„œ ์ปจ์„คํŒ…์€ ์ œ๊ฒŒ ์ฐธ ์‹ ๋‚˜๋Š” ์—…๋ฌด์ž…๋‹ˆ๋‹ค. ์ด๋ฒˆ ๊ธ€์—์„œ๋Š” ๋ช‡ ๋‹ฌ ์ „์— ์ง„ํ–‰ํ–ˆ๋˜ API ๋ฌธ์„œํ™” ์ปจ์„คํŒ…์—์„œ ๋ฐฐ์šด ๋‚ด์šฉ์„ ๊ณต์œ ํ•˜๋ ค ํ•ฉ๋‹ˆ๋‹ค. ์ฃผ์ œ๋Š” ์ƒˆ๋กœ์šด ์–ธ์–ด๋ฅผ ์œ„ํ•œ ์†Œ์Šค ์ฝ”๋“œ ์ฃผ์„ ๊ธฐ๋ฐ˜ API ๋ฌธ์„œํ™” ๋„๊ตฌ ๋งŒ๋“ค๊ธฐ์ž…๋‹ˆ๋‹ค. ์ •ํ™•ํžˆ ๋งํ•˜๋ฉด ‘๋„๊ตฌ ๋งŒ๋“ค๊ธฐ’๋ผ๊ธฐ๋ณด๋‹ค ‘๋„๊ตฌ ์ฐพ์•„ ์ ์šฉํ•˜๊ธฐ’์ด๋ฏ€๋กœ, ์ฝ”๋”ฉ์ด ๋งŽ์ด ํ•„์š”ํ•  ๊ฑฐ๋ผ๋Š” ๊ธฐ๋Œ€ ํ˜น์€ ์—ผ๋ ค๋Š” ๊ฐ€์Šด ํ•œํŽธ์— ๊ณ ์ด ์ ‘์–ด๋‘ฌ๋„ ์ข‹์Šต๋‹ˆ๋‹ค.

๋ฌธ์„œ ์—”์ง€๋‹ˆ์–ด๋ง๊ณผ API ๋ฌธ์„œํ™”

ํ…Œํฌ๋‹ˆ์ปฌ ๋ผ์ดํ„ฐ(technical writer)๋ผ๋Š” ๋ง์„ ๋“ค์œผ๋ฉด ๋Œ€๋ถ€๋ถ„ ‘๋ผ์ดํ„ฐ’๋ผ๋Š” ๋‹จ์–ด๋งŒ ๋ณด๊ณ  ‘๊ธ€ ์“ฐ๋Š” ์‚ฌ๋žŒ’์ด๋ผ ์ƒ๊ฐํ•˜๊ธฐ ์‹ญ์ƒ์ž…๋‹ˆ๋‹ค. ๋ฌผ๋ก  ํ‹€๋ฆฐ ๊ฒƒ์€ ์•„๋‹ˆ์ง€๋งŒ, ์‹ค์ƒ ํ‚ค๋ณด๋“œ๋ฅผ ๋‘๋“œ๋ฆฌ๋ฉฐ ๊ธ€ ์“ฐ๋Š” ์ผ์ด ํ…Œํฌ๋‹ˆ์ปฌ ๋ผ์ดํ„ฐ ์—…๋ฌด์˜ ๋Œ€๋ถ€๋ถ„์„ ์ฐจ์ง€ํ•˜์ง€๋Š” ์•Š์Šต๋‹ˆ๋‹ค. ํ•˜๋ฃจ์— ์–ผ๋งˆ ๋™์•ˆ ๊ธ€์„ ์“ฐ๋Š”์ง€ ์ธก์ •ํ•ด ๋ณธ ์ ์€ ์—†์œผ๋‚˜,ย ํ…Œํฌ๋‹ˆ์ปฌ ๋ผ์ดํ„ฐ ํ†ฐ ์กด์Šจ(Tom Johnson)์ด ๋งํ•˜๊ธฐ๋กœ๋Š” ์ผํ•˜๋Š” ์‹œ๊ฐ„์˜ย ์•ฝ 10%๋ผ๊ณ  ํ•ฉ๋‹ˆ๋‹ค.

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