Swagger

Swagger란?

swagger는 REST api 문서를 자동으로 생성해주는 라이브러리이다.

앞에서 만든 게시판 생성 API를 만들었으면 프런트엔드 개발자가 사용할 수 있도록 문서를 다음과 같이 만들어 줘야 한다.

url: /api/board
method: POST
request: json
EX) { “title”: “제목”, “content”: “내용”}
response: json
EX) { “code”: 0, “message”: “success”}

 

Swagger 적용

build.gradle에 springfox-swagger2 와 springfox-swagger-ui 라이브러리를 추가한다.

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

 

FullstackApplication에 Docket 빈을 추가한다.

@SpringBootApplication
@EnableSwagger2
public class FullstackApplication {
 
    public static void main(String[] args) {
        SpringApplication.run(FullstackApplication.class, args);
    }
 
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.eastflag.fullstack"))
                .paths(PathSelectors.any())
                .build();
    }
}

 

Swagger가 자동으로 API 문서를 작성해준다.

해당 주소 : http://localhost:8080/swagger-ui.html