WAS 1차 (프로젝트 생성 및 라이브러리 추가)

Spring Boot 프로젝트 생성

Spring Boot initializr 를 사용하여 스프링 부트 프로젝트를 생성 후 IDE에서 열어보기

https://start.spring.io/

 

 

java, Spring Boot 버전에 맞게 설정 후 사용할 디펜던시 추가

• Lombok: Getter, Setter 등 어노테이션 사용을 위해 추가
• Spring Web: Spring의 MVC 패턴을 사용하기 위해 추가
• Spring Boot Dev Tools: 소스 변경시 재기동 등 다양한 개발 편의를 위해 추가

---

프로젝트 실행

생성한 프로젝트를 VSCode에서 open 후  실행 확인

 

 

---

Swagger 라이브러리 추가

https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-starter-webmvc-ui/2.5.0

 

Swagger를 사용하기위한 springdoc 라이브러리 추가

 ps. Spring Boot 3.x 이상부터는 openAPI Starter WebMVC UI로 적용해야한다.

 

maven repository에서 springdoc을 찾아서 gradle 클릭 후 카피

 

 

build.gradle에 추가

 

접속

테스트 컨트롤러 및 openAPI 설정 

SwaggerConfig.java

package com.portfolio.portfolio_was.config;

import org.springdoc.core.models.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * SwaggerConfig
 */
@Configuration
public class SwaggerConfig {

  
  @Bean
  public GroupedOpenApi api() {
    String[] paths = {"/**"};
    // String[] pakcagesToScan = {"com.portfolio.portfolio_was"};
    return GroupedOpenApi.builder().group("springdoc-openapi")
    .pathsToMatch(paths)
    // .packagesToScan(pakcagesToScan)
    .build();
  }
}

 

TestController.java

package com.portfolio.portfolio_was.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;


@RequestMapping("/test")
@RestController
public class TestController {
 
  @GetMapping("/api1")
  @Tag(name = "test api")
  @Operation(summary = "test")
  public String test22() {
    return "test";
  }
}

 

 

---

https://github.com/Kmmanki/portfolio_was

GitHub - Kmmanki/portfolio_was: portfolio