티스토리 뷰

Spring Boot Swagger 적용기

안녕하세요. 오랫만에 글을 쓰게되는군요...하하하....


오늘은 RestApi 문서없이!! 간단한 라이브러리를통해 보여주는 Swagger를 공유하도록 해보겠습니다~


천천히 따라오시죠!


1. Swagger를 적용하기위해 library를 추가합시다. 저는 Gradle 세팅을 사용하기떄문에 Gradle로 추가하겠으며, xml을 사용하시는분들은 해당사항부분만 추가하여 적어주시면 되겠습니다~


// Rest API Document
compile "io.springfox:springfox-swagger2:2.7.0"
compile "io.springfox:springfox-swagger-ui:2.7.0"


2. Swagger를 사용하기위해 Config File 설정파일을 만들어주시면됩니다. 

@Configuration
@EnableSwagger2
public class SwaggerConfig {

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

}


이후 만들어진 Api를 확인하실떄는


http://localhost:8080/swagger-ui.html


위의 주소로 이동하신다면, 저희가 만든 Rest Controller 에 해당하는 내용들이 swagger 문서로 나오게됩니다 ^^


이상으로 Swagger를 사용하는방법에대해 포스팅해봤습니다.


다음번에는 다른 소식을 들고 돌아올게요 : ) 20000 ~

Recent Comments