본문 바로가기
백엔드/Spring

[Spring Swagger3.0] spring boot에 Swagger 3.0 실습 예제

by 작은소행성 2022. 11. 11.

의존성 추가

implementation "io.springfox:springfox-boot-starter:3.0.0"
implementation "io.springfox:springfox-swagger-ui:3.0.0"

 

 

SwaggerConfig.java 파일 추가

@Configuration
public class SwaggerConfig {
 
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.OAS_30)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
}
  • Docket : swagger 설정에 핵심이 되는 Bean 
  • apis : api 스펙이 작성되어 있는 패키지(controller) 지정
  • paths : apis에 있는 API 중 특정 path 선택

 

 

Controller 생성

@RestController
public class TestController {
 
    @GetMapping("/api/hello1")
    public String hello1() {
        return "hello";
    }
 
    @GetMapping("/api/hello2")
    public String hello2(@RequestParam String param) {
        return param;
    }
}

 

 

 

  • 접속 url

ttp://localhost:8080/swagger-ui/index.html

 

반응형