Swagger 란?

김민경·2022년 10월 30일
0

※ Maven 사용

  • OAS(Open Api Specifiction)
  • API 문서화를 쉽게 할 수 있도록 도와줌
  • 파라미터를 넣어 실제로 어떤 응답이 오는지 테스트 할 수 있음
  • pom.xml -> springfox-swagger-ui를 dependency 하여 사용

Swagger 설정

  • configuration 패키지 생성 -> SwggerConfiguration class 생성 -> @Configuration & @Bean 등록
@Configuration
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.OAS_30)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
}

📢 Swagger 접속 URL
-> http://localhost:8080/swagger-ui/

👀알아두기!

  • @SpringbootApplication이 실행 시 @ComponentScan이 @Component 시리즈 어노테이션이 붙은 클래스를 발견하여 빈(bean)을 등록함
  • @Component 시리즈란?
    • @Controller
    • @RestController
    • @Service
    • @Repository
    • @Configuration <- 위의 코드에서 사용 된 어노테이션

0개의 댓글