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

Tech Log ๐Ÿ› ๏ธ

์ค‘์ฒฉ ํด๋ž˜์Šค DTO ์‚ฌ์šฉ์‹œ swagger ์ธ์‹๋ฌธ์ œ ๋ณธ๋ฌธ

์นดํ…Œ๊ณ ๋ฆฌ ์—†์Œ

์ค‘์ฒฉ ํด๋ž˜์Šค DTO ์‚ฌ์šฉ์‹œ swagger ์ธ์‹๋ฌธ์ œ

sehaan 2023. 10. 10. 17:22

๊ฐœ์š”

swagger ์ ์šฉ ํ›„ ์ผ๋ถ€ API์— ๋Œ€ํ•ด์„œ ๋ชจ๋‘ ๋˜‘๊ฐ™์€ Request Body๊ฐ€ ๋ณด์ด๋Š” ํ˜„์ƒ์ด ๋ฐœ์ƒํ•˜์˜€๋‹ค.

์›์ธ

์šฐ๋ฆฌ๋Š” sealed interface ๋‚ด๋ถ€์— ์ค‘์ฒฉ ํด๋ž˜์Šค๋กœ dto๋ฅผ request ๋ผ๋Š” ์ด๋ฆ„์œผ๋กœ ๋งŒ๋“ค์–ด์ฃผ์—ˆ๋Š”๋ฐ,

swagger์—์„œ ๋˜‘๊ฐ™์€ ์ด๋ฆ„์˜ record๋“ค์„ ๊ตฌ๋ถ„ํ•˜์ง€ ๋ชปํ•œ๊ฒŒ ์›์ธ์ด์—ˆ๋‹ค.

ํ•ด๊ฒฐ

ํ•ด๋‹น ๋ธ”๋กœ๊ทธ์—์„œ application.yml์— ์„ค์ •์„ ์ถ”๊ฐ€ํ•ด์ฃผ๋ฉด ๋œ๋‹ค๋Š” ๊ฒƒ์„ ์•Œ๊ฒŒ๋˜์—ˆ๋‹ค.

 

swagger ์‚ฌ์šฉ์‹œ ํŒจํ‚ค์ง€๊ฐ€ ๋‹ค๋ฅธ ๋™์ผ ํด๋ž˜์Šค๋ฅผ ๊ตฌ๋ณ„ํ•˜์ง€ ๋ชปํ•˜๋Š” ์ด์Šˆ

 

swagger ์‚ฌ์šฉ์‹œ ํŒจํ‚ค์ง€๊ฐ€ ๋‹ค๋ฅธ ๋™์ผ ํด๋ž˜์Šค๋ฅผ ๊ตฌ๋ณ„ํ•˜์ง€ ๋ชปํ•˜๋Š” ์ด์Šˆ

์—ฌ๋Ÿฌ๋ช…์˜ ๊ฐœ๋ฐœ์ž๊ฐ€ ํŽ˜์–ด๋กœ ๊ฐœ๋ฐœ์„ ํ•˜๋‹ค๋ณด๋ฉด ํด๋ž˜์Šค๋ช…์€ ๋™์ผํ•˜์ง€๋งŒ ํŒจํ‚ค์ง€๋ฅผ ๋‹ค๋ฅด๊ฒŒ ํ•ด์„œ ์ƒ์„ฑํ•˜๊ฒŒ ๋˜๋Š” ๊ฒฝ์šฐ๊ฐ€ ์žˆ๋‹ค. ์ค‘๋ณต ํด๋ž˜์Šค๊ฐ€ ์•„๋‹ˆ๋ผ ์—„์—ฐํžˆ ๋‹ค๋ฅธ ํด๋ž˜์Šค์ธ๋ฐ ๋ช…์นญ์ด ์ค‘๋ณต๋˜๋Š” ๊ฒฝ์šฐ๋„

findmypiece.tistory.com

๋”ฐ๋ผ์„œ ํ•ด๋‹น ์„ค์ •์„ ์ถ”๊ฐ€ํ•ด์ฃผ์—ˆ๊ณ  ์ดํ›„ swagger๊ฐ€ ์ •์ƒ ๋™์ž‘๋จ์„ ํ™•์ธํ•˜์˜€๋‹ค.