[Spring Boot] Swagger

Swaager

Swagger란 개발한 REST API를 편리하게 문서화 해주고, 이를 통해서 관리 및 제 3의 사용자가 편리하게 API를 호출해보고 테스트 할 수 있는 프로젝트이다.

스프링에서 뿐만 아니라 다른 언어로 개발된 웹 프레임워크에서도 구성을 할 수 있다.

 

Spring Boot에서는 간단하게 springfox-boot-starter 를 gradle dependencies에 추가함으로 사용할 수 있다.

 

다만, 주의할 점은 운영환경과 같은 외부에 노출되면 안되는 곳에는 사용할 땐 주의 해야 한다.

 

Swagger 관련 Annotation들은 많지만, 그 중에서도 핵심이 되는 Annotation 몇 가지만 제시해주었다.

 

1. 프로젝트 생성

 

Spring initialize, Java 11, Gradle, lombok, spring web을 선택 후 프로젝트를 빌드한다.

Swagger dependency는 따로 제공하고 있지 않아서 google에 maven repository를 검색하여 해당 링크에서 

SpringFox boot starter를 검색한다.

 

Gradle 밑에 있는 글을 복사해 스프링에서 build.gradle의 Dependencies에 추가해주자.

 

그 후 우측 상단에 새로고침 모양이 있는데 클릭해주면 정상적으로 빌드가 되는 것을 확인할 수 있다.