[java] 자바 스프링 부트 스웨거 사용 방법

08 Dec 2023

java

자바 스프링 부트 개발자들 사이에서 API 문서를 생성하는 강력한 도구로 널리 사용되는 스웨거(Swagger)를 소개하고자 합니다.

1. 스웨거란

스웨거(Swagger)는 API 명세를 만들고 관리하는 오픈 소스 소프트웨어입니다. 스웨거를 사용하면 API를 손쉽게 문서화하고 사용자가 쉽게 이해할 수 있는 형태로 제공할 수 있습니다. 또한, 스웨거 UI를 통해 API를 시각적으로 탐색하고 테스트할 수 있는 기능도 제공됩니다.

2. 스프링 부트에서 스웨거 사용

스프링 부트에서 스웨거를 사용하기 위해서는 우선 springfox 라이브러리를 프로젝트에 추가해야 합니다. 이 라이브러리는 API 문서를 자동으로 생성하고 렌더링하는 기능을 제공합니다.

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

의존성을 추가한 후에는 @EnableSwagger2 어노테이션을 구성 클래스에 추가하고 Docket 빈을 생성하여 스웨거를 구성합니다.

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("your.base.package"))
                .paths(PathSelectors.any())
                .build();
    }
}

3. 스웨거 실행 및 확인

위와 같이 스웨거를 구성한 후에는 애플리케이션을 실행하고 http://localhost:8080/swagger-ui/로 접속하여 API 명세를 확인할 수 있습니다.

이처럼 스프링 부트에서 스웨거를 사용하면 API 문서를 쉽게 생성하고 관리할 수 있으며, 개발자와 사용자 간의 소통을 원활하게 할 수 있습니다. 더 자세한 정보는 스웨거 공식 홈페이지에서 확인할 수 있습니다.

이상으로 스프링 부트에서의 스웨거 사용 방법에 대해 알아보았습니다. 감사합니다.

1. 스웨거란

2. 스프링 부트에서 스웨거 사용

3. 스웨거 실행 및 확인

참고 자료