Swagger

Swagger 

 개발자가 API서버를 개발할 때, API의 스펙에 대한 명세를 편리하게 할 수 있는 API 자동 문서화 도구(프레임워크) 

 

Django로 Rest API 서버 개발시에만 자동 문서화 도구로 Swagger를 사용할 수 있는 것이 아니고, Spring과 엮어서 Swagger를 쓸 수 있다는 것을 알게 되었다. 

 1) Swagger 의존성 설정

 

 2) Swagger 설정 파일 생성 

@Configuration / @EnableSwagger2

SwaggerConfig.java 에서 해당 Controller를 Swagger API 문서로 지정

 

swagger-ui.html#/ 의 주소로 접근 하면 자동 문서화된 swagger docs를 볼 수 있다.

이렇게 되면 swagger docs의 가장 기본적인 기능들을 사용 할 수 있다.

 

@ApiParam 어노테이션은 멤버 변수에 대한 설명 및 다양한 설정을 지원합니다.

• value : 저장되야 할 값에 대한 설명을 명시합니다.

• required : 필수 여부를 지정합니다.