[Spring Boot] REST API 문서를 Swagger로 관리하기
안녕하세요 명동역 델리만쥬입니다~! 실무에서 REST API를 개발할때면 API 관련 문서를 만들어야 합니다. API의 요청, 반환 값이 변경되거나 주소 및 API 속성이 변경되었을시에 문서를 일일이 업데이트를 해줘야 하는 번거로움이 존재합니다. 이번 포스팅에서는 API관련 명세를 만들어주는 Swagger를 써보려고 합니다!~ 기본 베이스 ( Spring Boot, Spring MVC, AOP, Gradle을 적용한 REST API 설계 구조 ) 위의 가정 아래 시작하겠습니다! build.gradle에 아래와 같은 설정을 해줍니다. compile group: 'io.springfox', name: 'springfox-swagger-ui', version: '2.9.2' compile("io.springfox:springfox-swagger2:2.9.2") { exclude module: 'swagger-annotations' exclude module: 'swagger-models' } compile("io.swagger:swagger-annotations:1.5.21") compile("io.swagger:swagger-models:1.5.21") Colored by Color Scripter cs Swagger 기본 설정 위의 build.gradle의 설정이 끝난 후 Config 클래스를 생성해서 Swagger 기본 설정을 하려고 합니다. Config 디렉토리에 SwaggerConfig 클래스를 생성합니다. @Configuration @EnableSwagger2 public class SwaggerConfig { ...