๐Ÿช kakaotech campus

์นดํ…Œ์ผ | SNS ๋ชจ๋ธ๋ง (Swagger UI)

c0zi 2023. 6. 4. 15:58

๐Ÿ“Œ 8์ฃผ์ฐจ ํ•™์Šต ๋‚ด์šฉ - SNS ๋ชจ๋ธ๋ง์„ ํ†ตํ•œ DB(MySQL) ์ดํ•ด 


์ด๋ฒˆ ์ฃผ์ฐจ ๊ฐ•์˜๋Š” ํšŒ์› ์ •๋ณด ๋“ฑ๋ก, ์กฐํšŒ, ์ด๋ฆ„ ๋ณ€๊ฒฝ ๋“ฑ sns์˜ ๊ธฐ๋Šฅ์„ ๊ตฌํ˜„ํ•ด๋ณด๋ฉด์„œ MySQL์— ๋Œ€ํ•œ ์ดํ•ด๋ฅผ ๋†’์ผ ์ˆ˜ ์žˆ์—ˆ๋‹ค.

 

MySQL์„ ์ฒ˜์Œ ์ ‘ํ•˜๋ฉด์„œ SQL์ด ๋ญ˜๊นŒ ... ๋ช…๋ น์–ด๋“ค์„ ๋˜ ๊ณต๋ถ€ํ•ด์•ผ  ํ•˜๋‚˜ ... ๊ณ ๋ฏผ๋„ ๋˜๊ณ  ๊ฐ•์˜ ๋“ฃ๋Š” ์ค‘๊ฐ„ ์ค‘๊ฐ„ ๊ฒ€์ƒ‰ํ•˜๋ฉด์„œ ๊ฐ•์˜ ๋“ฃ๋Š” ์‹œ๊ฐ„์ด ๊ฝค ์˜ค๋ž˜ ๊ฑธ๋ ธ์—ˆ๋‹ค.

 

๊ทธ๋Ÿฌ๋‹ค๊ฐ€ ๋‹ค๋ฅธ ๋ถ„๋“ค์˜ ๋ธ”๋กœ๊ทธ๋ฅผ ์ฐพ์•„๋ณด๋‹ˆ SQL์— ๋Œ€ํ•ด ์ „๋ถ€ ์ดํ•ดํ•˜๋ฉฐ ๊ณต๋ถ€ํ•˜๋ ค๊ณ  ํ•˜์ง€ ๋ง๋ผ๋Š” ๋ง์„ ๋ณด๊ณ  ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค๋„ ์ž˜ ๋ชจ๋ฅด๋Š”๋ฐ, ๊ฐ•์˜ ํ๋ฆ„์ด๋‚˜ ์ž˜ ๋”ฐ๋ผ๊ฐ€๋ฉด์„œ ๊ฐ•์‚ฌ๋‹˜๊ป˜์„œ ๊ธฐ๋Šฅ ๊ตฌํ˜„ํ•˜์‹œ๋Š” ๋ฐฉ๋ฒ•, ํŒ๋“ค์ด๋ผ๋„ ์–ป์–ด๊ฐ€์ž ! ๋ผ๊ณ  ์ƒ๊ฐํ–ˆ๋‹ค.

 

 

๐Ÿ” Swagger


  • OpenAPI ์‚ฌ์–‘(์ด์ „์˜ Swagger ์‚ฌ์–‘)์„ ๊ธฐ๋ฐ˜์œผ๋กœ API์— ๋Œ€ํ•œ ๋ฌธ์„œ๋ฅผ ๋™์ ์œผ๋กœ ์ƒ์„ฑํ•˜๋Š” ์›น ๊ธฐ๋ฐ˜ ์ธํ„ฐํŽ˜์ด์Šค๋ฅผ ์ œ๊ณต
  • ๋Œ€๋ถ€๋ถ„์˜ ์‚ฌ์šฉ์ž๋“ค์€ ์Šค์›จ๊ฑฐ UI ๋„๊ตฌ๋ฅผ ํ†ตํ•ด ์Šค์›จ๊ฑฐ๋ฅผ ์‹๋ณ„ํ•˜๋ฉฐ ์Šค์›จ๊ฑฐ ํˆด์…‹์—๋Š” ์ž๋™ํ™”๋œ ๋ฌธ์„œํ™”, ์ฝ”๋“œ ์ƒ์„ฑ, ํ…Œ์ŠคํŠธ ์ผ€์ด์Šค ์ƒ์„ฑ ์ง€์›์ด ํฌํ•จ

*์˜คํ”ˆ ์†Œ์Šค : ์—ฌ๋Ÿฌ ํŒ€๊ณผ ๊ฐœ๋ฐœ์ž๊ฐ€ ์ง€์†์ ์ธ ๊ฐœ๋ฐœ ๋ฐ ์—…๋ฐ์ดํŠธ๋ฅผ ์œ„ํ•ด ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ์ด๋‚˜ ์ˆ˜์ • ์‚ฌํ•ญ์„ ์ž์œ ๋กญ๊ฒŒ ๊ฐœ์„ ํ•˜์—ฌ ๊ธฐ์—ฌํ•  ์ˆ˜ ์žˆ๋„๋ก ๋งŒ๋“ค์–ด์ ธ ๋ฐฐํฌ๋˜๋Š” ์†Œํ”„ํŠธ์›จ์–ด

 

*ํ”„๋ ˆ์ž„์›Œํฌ : ํŠน์ • ํ”„๋กœ๊ทธ๋žจ์„ ๊ฐœ๋ฐœํ•˜๊ธฐ ์œ„ํ•œ ์—ฌ๋Ÿฌ ์š”์†Œ๋“ค๊ณผ ๋ฉ”๋‰ด์–ผ์ธ ๋ฃฐ์„ ์ œ๊ณตํ•˜๋Š” ํ”„๋กœ๊ทธ๋žจ

 

๐Ÿ“‹ Swagger UI


 

๐Ÿ–ฅ๏ธ ํšŒ์›์ •๋ณด ๋“ฑ๋ก/์กฐํšŒ ๊ตฌํ˜„


POST๋ฅผ ํ†ตํ•œ ํšŒ์›์ •๋ณด ๋“ฑ๋ก
๋“ฑ๋ก ์„ฑ๊ณต ๐Ÿ”ฅ

 

id : 5์ธ ๊ฒƒ์„ ํ™•์ธํ•˜๊ณ  GET์„ ํ†ตํ•ด ํšŒ์›์ด ์ •๋ณด๋ฅผ ์กฐํšŒํ•  ์ˆ˜ ์žˆ๋„๋ก ๊ตฌํ˜„ํ•œ๋‹ค.

 

GET์„ ํ†ตํ•ด ํšŒ์›์ •๋ณด ์กฐํšŒ

 

๐Ÿ–ฅ๏ธ ํšŒ์› ์ด๋ฆ„ ๋ณ€๊ฒฝ


์ด๋ฆ„ ๋ณ€๊ฒฝ
๋ณ€๊ฒฝ ์„ฑ๊ณต ๐Ÿ”ฅ

 

๐Ÿ“ 8์ฃผ์ฐจ ๊ฐ•์˜ ํ›„๊ธฐ


์นดํ…Œ์ผ์€ ๊ธฐ๋ณธ์ ์œผ๋กœ ๋‹ค ์•Œ๊ณ  ์žˆ๋‹ค๋Š” ๋‚ด์šฉ ์ „์ œํ•˜์— ๊ฐ•์˜๊ฐ€ ๋งŽ์ด ์ง„ํ–‰๋˜๊ธฐ ๋•Œ๋ฌธ์—, ์ด๊ฒƒ์ €๊ฒƒ ๋‹ค ์•Œ๊ณ  ๋„˜์–ด๊ฐ€๋ ค๋‹ค ๋ณด๋ฉด ๊ฐ•์˜๊ฐ€ ๋ฐ€๋ ค์žˆ๋Š” ์ƒํ™ฉ์„ ๋งˆ์ฃผํ•˜๊ฒŒ ๋œ๋‹ค๋Š” ๊ฑธ ์•Œ์•„๋ฒ„๋ ธ๋‹ค.. ใ…Žใ…Ž ๊ทธ๋ž˜์„œ ๊ฐ•์˜๋Š” ์ญ‰ ๋“ค์œผ๋ฉด์„œ ๋ชจ๋ฅด๋Š” ์šฉ์–ด, ํˆด ์œ„์ฃผ๋กœ ํ˜ผ์ž ๊ณต๋ถ€ํ•˜๊ณ  ๊ธฐ๋กํ•˜๋ ค๊ณ  ํ•œ๋‹ค.

 

๐Ÿ—‚๏ธ ์ฐธ๊ณ  ์ž๋ฃŒ 


1. https://ko.wikipedia.org/wiki/%EC%8A%A4%EC%9B%A8%EA%B1%B0_(%EC%86%8C%ED%94%84%ED%8A%B8%EC%9B%A8%EC%96%B4) 

 

์Šค์›จ๊ฑฐ (์†Œํ”„ํŠธ์›จ์–ด) - ์œ„ํ‚ค๋ฐฑ๊ณผ, ์šฐ๋ฆฌ ๋ชจ๋‘์˜ ๋ฐฑ๊ณผ์‚ฌ์ „

์œ„ํ‚ค๋ฐฑ๊ณผ, ์šฐ๋ฆฌ ๋ชจ๋‘์˜ ๋ฐฑ๊ณผ์‚ฌ์ „. -->

ko.wikipedia.org

 

2. fastcampus DB(MySQL) ๊ฐ•์˜ ๋ฐ GitHub

https://github.com/koogk7/fastcampus-mysql

 

GitHub - koogk7/fastcampus-mysql

Contribute to koogk7/fastcampus-mysql development by creating an account on GitHub.

github.com