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

๋ชฉ๋กapi ๋ช…์„ธ (2)

JUINTINATION

Postman์„ ํ™œ์šฉํ•œ API ๋ฌธ์„œ ๋งŒ๋“ค๊ธฐ

์ง€๋‚œ๋ฒˆ์— Swagger๋ฅผ ํ™œ์šฉํ•œ API Specification์— ๋Œ€ํ•œ ๊ธ€์„ ์ž‘์„ฑํ–ˆ์—ˆ๋‹ค. Swagger๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ๊ฐ„๋‹จํ•˜๊ฒŒ API ๋ช…์„ธ๊ฐ€ ๊ฐ€๋Šฅํ•˜๋‹ค๋Š” ๋‚ด์šฉ์˜ ๊ธ€์ด์—ˆ๋Š”๋ฐ, ์ด๋Ÿฌํ•œ Swagger ๋ง๊ณ ๋„ ๋‹ค๋ฅธ ์—ฌ๋Ÿฌ ๋ฐฉ๋ฒ•์œผ๋กœ API ๋ฌธ์„œ๋ฅผ ๋งŒ๋“ค ์ˆ˜ ์žˆ๋‹ค๋Š” ์‚ฌ์‹ค์„ ์•Œ๊ฒŒ ๋˜์—ˆ๋‹ค. Swagger๋ฅผ ํ™œ์šฉํ•œ API SpecificationOpen API Document ๋ช…์„ธ ์ œ์•ˆ์Šคํ”„๋ง๋ถ€ํŠธ๋ฅผ ํ™œ์šฉํ•œ todo-api-server์˜ ๋‚ด์šฉ์„ ๊นƒํ—ˆ๋ธŒ์— ์˜ฌ๋ฆฌ๊ณ  ์–ผ๋งˆ ์ง€๋‚˜์ง€ ์•Š์•˜์„ ๋•Œ ๊ฐ‘์ž๊ธฐ ์•Œ๋ฆผ์ด ์™”๋‹ค. ์ค€ํ˜ธ ํ˜•์ด API ๋ช…์„ธ๋ฅผ ํ•˜๋ฉด ์ข‹๊ฒ ๋‹ค๊ณ  Issue๋ฅผ ๋‚จ๊ธด ๊ฒƒ์ด์—ˆ๋‹ค. ๊ทธ๋ž˜juintination.tistory.comPostman๋‚˜๋Š” Postman์„ ์ง€๊ธˆ๊นŒ์ง€ API ํ…Œ์ŠคํŠธ๋ฅผ ์ง„ํ–‰ํ•  ๋•Œ๋งŒ ์‚ฌ์šฉํ•ด์™”๋‹ค. ์ง€๋‚œ ์ŠคํผํŠธ ํ”„๋กœ์ ํŠธ์—์„œ ์ฒ˜์Œ ์‚ฌ..

StudyNote 2024. 7. 7. 15:38
Swagger๋ฅผ ํ™œ์šฉํ•œ API Specification

Open API Document ๋ช…์„ธ ์ œ์•ˆ์Šคํ”„๋ง๋ถ€ํŠธ๋ฅผ ํ™œ์šฉํ•œ todo-api-server์˜ ๋‚ด์šฉ์„ ๊นƒํ—ˆ๋ธŒ์— ์˜ฌ๋ฆฌ๊ณ  ์–ผ๋งˆ ์ง€๋‚˜์ง€ ์•Š์•˜์„ ๋•Œ ๊ฐ‘์ž๊ธฐ ์•Œ๋ฆผ์ด ์™”๋‹ค. ์ค€ํ˜ธ ํ˜•์ด API ๋ช…์„ธ๋ฅผ ํ•˜๋ฉด ์ข‹๊ฒ ๋‹ค๊ณ  Issue๋ฅผ ๋‚จ๊ธด ๊ฒƒ์ด์—ˆ๋‹ค. ๊ทธ๋ž˜์„œ ๋‚˜๋Š” ์ง€๋‚œ ์ŠคํผํŠธ ํ”„๋กœ์ ํŠธ์—์„œ ์‚ฌ์šฉํ•œ ์ ์ด ์žˆ๋Š” Swagger๋ฅผ ์‚ฌ์šฉํ•˜๊ธฐ๋กœ ํ–ˆ๋‹ค. (์ƒค๋ผ์›ƒ ํˆฌ ์ค€ํ˜ธํ˜•) TODO API SERVER with ์Šคํ”„๋ง๋ถ€ํŠธ์ข…๊ฐ•์„ ํ•˜๊ณ  ์ด๋Ÿฐ์ €๋Ÿฐ ๋ฐ€๋ฆฐ ์ผ์„ ์ฒ˜๋ฆฌํ•˜๊ณ  ๋ณด๋‹ˆ ์–ด๋Š์ƒˆ 7์›”.. ๋‚ ์”จ๊ฐ€ ๊ฒฌ๋”œ ์ˆ˜ ์—†์„ ๋งŒํผ ๋”์›Œ์ง€๊ณ  ์ด๋Ÿฌ๋‹ค๊ฐ€ ๋งˆ์ง€๋ง‰ ๋ฐฉํ•™์„ ์•„๋ฌด๊ฒƒ๋„ ์•ˆ ํ•˜๊ณ  ์ข…์ผ ์œ ํŠœ๋ธŒ๋งŒ ๋ณด๋ฉด์„œ ๋ณด๋‚ผ ๊ฒƒ ๊ฐ™์•„์„œ ์˜ˆ์ „์— ์ž‘์„ฑํ–ˆjuintination.tistory.comSwaggerSwagger๋ž€ Restful API๋ฅผ ๋ฌธ์„œํ™”ํ•˜๊ณ , ์‚ฌ์šฉ์ž๊ฐ€ ์‰ฝ๊ฒŒ ํ…Œ์ŠคํŠธํ•˜๊ณ  ํ˜ธ์ถœํ• ..

StudyNote 2024. 7. 1. 23:49