๊ด€๋ฆฌ ๋ฉ”๋‰ด

๋ชฉ๋กswagger (1)

๋‚˜์˜ ๋ชจ์–‘

057 | API Documentation, Swagger, SpringRest

๐ŸŽˆ API Documentation ํด๋ผ์ด์–ธํŠธ๋Š” HTTP request URL(๋˜๋Š” URI)์„ ํ†ตํ•ด ์„œ๋ฒ„์— ๋ฐ์ดํ„ฐ๋ฅผ ์š”์ฒญํ•œ๋‹ค. ์ด ๋•Œ ํด๋ผ์ด์–ธํŠธ๊ฐ€ REST API ๋ฐฑ์—”๋“œ ์• ํ”Œ๋ฆฌ์ผ€์ด์…˜์— ์š”์ฒญ์„ ์ „์†กํ•˜๊ธฐ ์œ„ํ•ด์„œ ์•Œ์•„์•ผ ๋˜๋Š” ์š”์ฒญ ์ •๋ณด(์š”์ฒญ URL(๋˜๋Š” URI), request body, query parameter ๋“ฑ)๋ฅผ ๋ฌธ์„œํ™” ํ•œ ๊ฒƒ์„ API ๋ฌธ์„œ ๋˜๋Š” API ์ŠคํŽ™(์‚ฌ์–‘)์ด๋ผ๊ณ  ํ•œ๋‹ค. API ๋ฌธ์„œ๋Š” ๊ฐœ๋ฐœ์ž๊ฐ€ ์ง์ ‘ ์ˆ˜๊ธฐ๋กœ ์ž‘์„ฑํ•  ์ˆ˜๋„ ์žˆ์ง€๋งŒ, ๊ฐœ๋ฐœ์ค‘์ด๊ฑฐ๋‚˜ ์œ ์ง€๋ณด์ˆ˜๋ฅผ ํ•  ๋•Œ API๊ฐ€ ์ˆ˜์ •๋  ์ˆ˜๋„ ์žˆ๊ณ , ํด๋ผ์ด์–ธํŠธ์—๊ฒŒ ์ œ๊ณต๋œ API ์ •๋ณด์™€ ์ˆ˜๊ธฐ๋กœ ์ž‘์„ฑ๋œ API ๋ฌธ์„œ ์ •๋ณด๊ฐ€ ๋‹ค๋ฅผ ์ˆ˜ ์žˆ๊ธฐ ๋•Œ๋ฌธ์— ๋น„ํšจ์œจ์ ์ด๋‹ค. API ๋ฌธ์„œ ์ž๋™ํ™”๋ฅผ ํ†ตํ•ด API์—์„œ ์ƒ๊ธฐ๋Š” ์—๋Ÿฌ ๋ฐœ์ƒ์„ ๋ฐฉ์ง€ํ•˜๊ณ  ์ž‘์—… ์‹œ๊ฐ„์„ ๋‹จ์ถ•ํ•  ์ˆ˜ ์žˆ๋‹ค. ๐Ÿงฉ Sw..

SEB/TIL 2022. 9. 14. 22:56