๋ณธ๋ฌธ ๋ฐ”๋กœ๊ฐ€๊ธฐ
๋ฐฑ์—”๋“œ/Spring boot

๊ณต๊ฐœ๋œ API๋ฅผ ๊ฐ€์ ธ์™€ ํ”„๋กœ์ ํŠธ ๋งŒ๋“ค๊ธฐ(1)

by sh119 2023. 4. 21.

๋ณดํ†ต ํ”„๋กœ์ ํŠธ ์ƒ์„ฑ์‹œ ํฌ๋กค๋ง์„ ํ•˜๊ฑฐ๋‚˜ ๊ณต๊ฐœ๋œ API๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ์›ํ•˜๋Š” ๋ฐ์ดํ„ฐ๋ฅผ ๋ฐ›์•„์™€ ์ฝ”๋“œ๋ฅผ ์งœ๋Š” ๊ฒฝ์šฐ๊ฐ€ ๋งŽ๋‹ค. 

์ด๋•Œ ๊ณต๊ฐœ๋œ API๋ฅผ ์–ด๋–ป๊ฒŒ ์ž˜ ์ด์šฉํ• ์ง€ ์ ์–ด๋ณด๊ณ ์ž ํ•œ๋‹ค. 

 

๊ณต๊ฐœ๋œ API ๊ณ ๋ฅด๋Š” ๋ฐฉ๋ฒ•

1. API document ์ฐธ๊ณ ํ•˜์—ฌ ๊ธˆ์•ก, ํ˜ธ์ถœ ๊ฐ€๋Šฅ ํšŸ์ˆ˜ ์›ํ•˜๋Š” ๋ฐ์ดํ„ฐ๊ฐ€ ์žˆ๋Š”์ง€ ํ™•์ธํ•œ๋‹ค.

2. API๊ฐ€ ๋‹ค๋ฃจ๋Š” ๋ฐ์ดํ„ฐ ๋ฒ”์œ„ (request, response ๊ฐ’๊ณผ ํ˜•์‹ ๋“ฑ) ์„ ํ™•์ธํ•œ๋‹ค.

 

์›ํ•˜๋Š” ์‚ฌ์ดํŠธ์—์„œ API ์ธ์ฆ ๋ฐ›๊ธฐ

- API ์ธ์ฆ์ด๋ž€? API ๋ฅผ ํ˜ธ์ถœํ•˜๋Š” ๋Œ€์ƒ์„ ํ™•์ธํ•˜๋Š” ์ ˆ์ฐจ์ด๋‹ค.

API ์ธ์ฆ ๋ฐฉ์‹์—๋Š”  API Key ๋ฐฉ์‹๊ณผ API Token ๋ฐฉ์‹์ด ์žˆ๋‹ค.  ๋˜ํ•œ ์–ด๋–ค ๋ฐฉ์‹์„ ์“ฐ๋ƒ์— ๋”ฐ๋ผ ๊ตฌํ˜„ ๋‚œ์ด๋„์™€ ๋ณด์•ˆ ์ˆ˜์ค€์ด ๋‹ฌ๋ผ์ง„๋‹ค.