Spring Boot에서 Swagger를 활용한 API 문서화

Spring Boot 프로젝트에서 API를 문서화하고 테스트하는 것은 매우 중요합니다. Swagger를 사용하면 API를 자동으로 문서화하고 사용자 친화적인 인터페이스를 제공할 수 있습니다. 이 글에서는 Spring Boot에서 Swagger를 설정하는 방법과 주요 기능을 알아보고, 간단한 예제를 통해 API 문서화를 실습해 보겠습니다.

 

Swagger 소개: Swagger는 API 문서를 자동으로 생성하고 관리하는 도구로, OpenAPI 명세를 준수합니다. Spring Boot에서는 springfox라는 라이브러리를 사용하여 Swagger를 쉽게 설정할 수 있습니다.

 

Spring Boot에서의 Swagger 설정:

• springfox-boot-starter를 의존성으로 추가하여 Spring Boot 프로젝트에 Swagger를 적용합니다.
• Docket 빈을 설정하여 Swagger의 주요 기능을 구성합니다.

Swagger UI 사용하기:

• Spring Boot 애플리케이션을 실행한 후 "/swagger-ui.html" 엔드포인트로 접속하면 Swagger UI를 통해 API 문서를 확인할 수 있습니다.
• Swagger UI에서는 API 엔드포인트의 목록과 각각의 요청 및 응답을 테스트할 수 있는 기능을 제공합니다.

728x90

Swagger 설정 예제 코드:

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.example.controller"))
            .paths(PathSelectors.any())
            .build();
    }
}

 

Swagger Annotations 사용하기:

• Swagger Annotations을 사용하여 API 문서에 설명을 추가하고 요청/응답 모델을 정의할 수 있습니다.
• @ApiOperation, @ApiParam, @ApiModel 등의 어노테이션을 활용하여 API 문서를 더욱 자세하게 작성할 수 있습니다.

Spring Boot에서 Swagger를 사용하면 API 문서화를 자동화하고 관리하기 쉽습니다. Swagger를 통해 API 사용자들은 명확한 API 문서를 확인하고 테스트할 수 있으며, 개발자들은 API 변경 사항을 신속하게 반영할 수 있습니다.

반응형