MapleStory Cookie With Halo

๐Ÿƒ Spring/๐Ÿƒ Spring Boot

[SpringBoot][Maven][RestAPI]ํ™˜๊ฒฝ์„ค์ •(์˜์กด์„ฑ ์ถ”๊ฐ€-web, swagger, lombok)

๋‰ด์ด NUEY 2025. 1. 26. 18:22
๋ฐ˜์‘ํ˜•

 

SpringBoot ๋‹ค์šด๋กœ๋“œ

 

  1. https://start.spring.io/์—์„œ ์•„๋ž˜ ์บก์ฒ˜๋Œ€๋กœ ์ž…๋ ฅ ํ›„ GENERATE ๋ฒ„ํŠผ์„ ๋ˆ„๋ฅธ๋‹ค.
  2. ๋‹ค์šด๋กœ๋“œ ๋ฐ›์€ ํŒŒ์ผ ์••์ถ•์„ ํ’€๊ณ  VScode์— ๋ถˆ๋Ÿฌ์˜ต๋‹ˆ๋‹ค.
  3. git์— ์˜ฌ๋ฆฌ๊ณ  ์‹œ์ž‘ํ•˜๊ฒ ์Šต๋‹ˆ๋‹ค.
    2025.01.02 - [๐Ÿ˜ผ Git] - [Git]์ดˆ๊ฐ„๋‹จ ๋กœ์ปฌ ์›Œํฌ์ŠคํŽ˜์ด์Šค repository์— ์˜ฌ๋ฆฌ๊ธฐ

  4. ํ”„๋กœ์ ํŠธ๋ฅผ Run์„ ๋ˆŒ๋Ÿฌ ์‹คํ–‰ํ–ˆ์„ ๋•Œ ์•„๋ž˜์ฒ˜๋Ÿผ ๋œจ๋ฉด ์ž˜ ์ง„ํ–‰๋œ ๊ฒ๋‹ˆ๋‹ค.
  5. pom.xml
    1. ์˜์กด์„ฑ spring-boot-starter๋ฅผ ์ฐพ์•„ ๋ณต์‚ฌํ•ฉ๋‹ˆ๋‹ค.
    2. ์•„๋ž˜ ๋ถ™์—ฌ๋„ฃ๊ธฐํ•ด์„œ -web์„ ๋์— ๋ถ™์—ฌ์ค๋‹ˆ๋‹ค.


  6. ๋‹ค์‹œ ํ”„๋กœ์ ํŠธ๋ฅผ ์‹คํ–‰ํ•ด๋ณด๋ฉด Tomcat ๋“ฑ์ด ์„ค์น˜ ๋˜๊ณ  http://127.0.0.1:8080/ ๋กœ ๋“ค์–ด๊ฐ€๋ณด๋ฉด ๊ธฐ๋ณธํŽ˜์ด์ง€๊ฐ€ ์ƒ์„ฑ๋œ๋‹ค.



 

Swagger ์ถ”๊ฐ€
: ์ธํ„ฐ๋„ท์ฐฝ์œผ๋กœ ๋ฉ”์„œ๋“œ ํ…Œ์ŠคํŠธํ•˜๊ธฐ

 

  1. controller ํŒจํ‚ค์ง€์™€ ๊ทธ ์•ˆ์— QuickController ํด๋ž˜์Šค ๋งŒ๋“ค๊ณ  ๊ฐ„๋‹จํ•œ ๋ฉ”์„œ๋“œ๋ฅผ ๋งŒ๋“ค์—ˆ๋‹ค.
  2. ๊ตฌ๊ธ€์— maven springdoc-openapi-starter-webmvc-ui ์„ ๊ฒ€์ƒ‰ํ•ด ๋“ค์–ด๊ฐ„๋‹ค.
  3. ์ฒซ๋ฒˆ ์งธ ๋ฒ„์ „์„ ํด๋ฆญํ•ด ๋“ค์–ด๊ฐ„๋‹ค.
  4. ํ…์ŠคํŠธ๋ฅผ ๋ณต์‚ฌํ•œ๋‹ค.
  5. pom.xml ์— ์ถ”๊ฐ€ํ•œ๋‹ค.
  6. ๋ธŒ๋ผ์šฐ์ €๋กœ http://127.0.0.1:8080/swagger-ui/index.html ๋กœ ์ด๋™
    • swagger์ฐฝ์ด ์—ด๋ฆฐ๋‹ค.
    • swagger๋ฅผ ์ด์šฉํ•ด ๊ฐ„๋‹จํ•˜๊ฒŒ ๋ฉ”์„œ๋“œ๋ฅผ ์‹คํ–‰ํ•ด ๋ณผ์ˆ˜ ์žˆ๋‹ค.



 

Lombok ์ถ”๊ฐ€

 

  1. ์œ„ ์Šค์›จ๊ฑฐ๋ฅผ ๋ณต์‚ฌํ•œ ๋ฉ”์ด๋ธ ๋ฆฌํฌ์ง€ํ† ๋ฆฌ๋ฅผ ๋“ค์–ด๊ฐ„๋‹ค.
  2. Lombok ์„ ๊ฒ€์ƒ‰ํ•œ๋‹ค.
  3. ์ฒซ๋ฒˆ์งธ ๋ฒ„์ „ ํด๋ฆญ.
  4. ํ…์ŠคํŠธ ๋ณต์‚ฌ
  5. pom.xml ์— ์ถ”๊ฐ€.
  6. EXTENSION ์— lombok ์„ ์ถ”๊ฐ€ํ•œ๋‹ค.


  7.  ์Šค์›จ๊ฑฐ๋กœ ์ฝ”๋“œ๋ฅผ ์‹คํ–‰ํ–ˆ์„ ๋•Œ
  8. ์ปจํŠธ๋กค๋Ÿฌ์—  @Slf4j  ๋ฅผ ์ถ”๊ฐ€ํ•˜๊ณ  log๋ฅผ ์ถ”๊ฐ€ํ•œ๋‹ค.
  9. log๊ฐ€ ์ถœ๋ ฅ๋˜๋Š” ๊ฒŒ ํ™•์ธ๋œ๋‹ค.

 


์ฐธ์กฐ์˜์ƒ

๋ฐ˜์‘ํ˜•