[Spring] Swagger

Swagger란?

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

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

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

 

Swagger Annotation

@Api : 클래스를 스웨거의 리소스로 표시

@ApiOperation : 특정경로의 오퍼레이션 HTTP 메소드 설명

@ApiParam : 오퍼레이션 파라미터에 메타 데이터 설명

@ApiRespoonse : 오퍼레이션의 응답 지정

@ApimodelProperty : 모델의 속성 데이터를 설명

@ApiImplicitParam : 메소드 단위의 오퍼레이션 파라미터를 설명

@ApiImplicitparams

 

maven repository 사이트에서 Springfox boot Starter를 사용하면 된다.

https://mvnrepository.com/

 

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