[우아한테크캠프] RESTful API 문서 만들기

Swagger를 사용하는 이유
RESTful API를 문서화하기 위해
API 문서를 일반 문서로 작성하게 되면 API가 수정될 때마다 문서를 수정해줘야 한다. Swagger는 이를 자동화 해준다.

장점
Swagger로 API 문서를 만들면 문서 자체가 API 설명이면서 문서에서 바로 테스트도 할 수 있다.

1. 라이브러리 추가

compile('io.springfox:springfox-swagger2:2.7.0')
compile('io.springfox:springfox-swagger-ui:2.7.0')

2. 빈 등록

@Slf4j
@Configuration
@EnableSwagger2
public class WebMvcConfig implements WebMvcConfigurer {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("team7_pair1")
                .apiInfo(apiInfo())
                .select()
                .paths(PathSelectors.ant("/api/**"))
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Team7_pair1")
                .description("API Documentation")
                .version("1.0")
                .build();
    }

※ 디테일한 설정은 필요할 때 찾아보면서 설정하면 된다.