API 문서용 Swagger

Swagger는 개발자가 RESTful API를 설계, 구축, 문서화 및 사용하는 데 도움이 되는 오픈 소스 소프트웨어 프레임워크입니다. Swagger 설명서는 Swagger 사양을 사용하여 생성된 RESTful API를 나타냅니다. Swagger 사양은 REST API에 대한 표준 인터페이스 설명 언어입니다. 이를 통해 개발자는 API 구조를 설명하고 사람이 읽을 수 있는 형식으로 문서를 생성할 수 있습니다. 생성된 Swagger 설명서에는 API 끝점, 요청 및 응답 매개변수, 기타 관련 세부 정보에 대한 정보가 포함되어 있습니다. 다른 개발자가 API의 기능을 이해하고 API를 호출하는 데 사용할 수 있습니다.

스웨거 기능

Swagger 설명서는 다음과 같은 여러 기능을 제공합니다.

1. 대화형 문서: 개발자가 API 호출을 시도하고 브라우저 기반 UI에서 응답을 볼 수 있습니다.
2. API 정의: API가 수행하는 작업, 엔드포인트, 매개변수 및 예상되는 응답에 대한 명확하고 간결하며 인간 친화적인 정의를 제공합니다.
3. 코드 생성: 여러 프로그래밍 언어로 서버 및 클라이언트 코드를 생성하여 개발 프로세스 속도를 높입니다.
4. 확인: API 사양을 충족하는지 확인하기 위해 API 요청 및 응답을 자동으로 확인합니다.
5. 문서 생성: HTML, JSON 및 YAML을 포함한 다양한 형식의 API 문서를 자동으로 생성합니다.
6. 협업: API 문서를 위한 중앙 집중식 위치를 제공하여 API 작성자, 개발자 및 이해 관계자 간의 협업을 지원합니다.
7. 테스트: API 호출을 테스트하고 원하는 동작을 충족하는지 확인하기 위한 환경을 제공합니다.
8. 버전 관리: API 버전 관리를 지원하고 사용자가 여러 버전의 API를 보고 작업할 수 있습니다.

Swagger 설명서는 다음을 포함한 여러 프로그래밍 언어를 지원합니다.

1. 자바
2. Node.js
3. PHP
4. 파이썬
5. 루비
6. 가다
7. 씨#
8. 스칼라
9. 펄

스프링 부트에서 Swagger 활성화

스프링 부트 애플리케이션에서 Swagger 설명서를 활성화하려면 다음 단계를 따라야 합니다.

1. springfox-swagger2 및 springfox-swagger-ui 종속성을 프로젝트에 추가합니다.
2. @EnableSwagger2로 구성 클래스에 주석을 달아 Spring Boot 애플리케이션에서 Swagger 지원을 활성화합니다.
3. API 버전, 제목 및 설명과 같은 Swagger 속성을 구성하기 위해 Docket 빈을 만듭니다.
4. @Api, @ApiOperation, @ApiParam 등과 같은 적절한 Swagger 주석으로 RESTful API에 주석을 답니다.
5. Spring Boot 애플리케이션을 실행하고 URL에서 Swagger UI에 액세스합니다.http://localhost:port/swagger-ui.html, 여기서 port는 애플리케이션이 실행 중인 HTTP 포트입니다.

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

Spring REST API로 Swagger 2 설정 | 발둥

OpenAPI 3.0을 사용하여 Spring REST API 문서화 | 발둥