Community

๐Ÿ“Œ API ๋ฌธ์„œํ™”๋ฅผ ์œ„ํ•œ ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ

๋ฆฌ๋””์—์„œ ๊ฐœ๋ฐœํ•œ Tspec ์ด๋ผ๋Š” ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ๋ฅผ ์†Œ๊ฐœํ•˜๋Š” ๊ธ€์ž…๋‹ˆ๋‹ค. API ๋ฌธ์„œ๋Š” ํšจ์œจ์ ์ธ ์ปค๋ฎค๋‹ˆ์ผ€์ด์…˜์„ ์œ„ํ•œ ์ค‘์š”ํ•œ ๋ถ€๋ถ„์ด์ฃ . ํŒ€ ์ƒํ™ฉ์— ํ•„์š”ํ•˜๋‹ค๋ฉด ํ•œ ๋ฒˆ์ฏค ๊ณ ๋ คํ•ด๋ด๋„ ์ข‹์„ ๋„๊ตฌ์ธ ๊ฒƒ ๊ฐ™์Šต๋‹ˆ๋‹ค. - ํ˜น์‹œ TypeScript๋กœ REST API๋ฅผ ๋งŒ๋“ค๋ฉด์„œ โ€œํƒ€์ž…๋งŒ์œผ๋กœ API ๋ฌธ์„œ๋ฅผ ์ž๋™์œผ๋กœ ๋งŒ๋“ค ์ˆœ ์—†์„๊นŒ?๐Ÿค”โ€๋ผ๋Š” ์ƒ๊ฐ์„ ํ•ด๋ณด์‹  ์  ์—†์œผ์‹ ๊ฐ€์š”? ์ด๋Ÿฌํ•œ ๊ธฐ๋Œ€๋ฅผ ํ˜„์‹ค๋กœ ๋งŒ๋“ค์–ด ์ฃผ๋Š” ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ๊ฐ€ ๋ฐ”๋กœ Tspec์ž…๋‹ˆ๋‹ค. Tspec: TypeScript ํƒ€์ž…๊ณผ JSDoc์„ ๊ธฐ๋ฐ˜์œผ๋กœ API ๋ฌธ์„œํ™”๋ฅผ ์ž๋™ํ™”ํ•ด์ฃผ๋Š” ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ์ž…๋‹ˆ๋‹ค. ๋‹จ ๋ช‡ ์ค„์˜ ์ฝ”๋“œ ์ถ”๊ฐ€๋งŒ์œผ๋กœ ๋ˆ„๊ตฌ๋‚˜ ์†์‰ฝ๊ฒŒ REST API๋ฅผ ๋ฌธ์„œํ™”ํ•  ์ˆ˜ ์žˆ๋„๋ก ๋„์™€์ค๋‹ˆ๋‹ค.

์•Œ๋ฆผ

์•Œ๋ฆผ์ด ์—†์Šต๋‹ˆ๋‹ค