Swagger

https://github.com/HoJin-jjimgo/Spring

SWAGGER

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

운영환경과 같은 외부에 노출되면 안되는 곳에서 사용해야 하며

springfox-boot-starter를 gradle dependencies에 추가해줌으로써
사용 할수가 있다

===============================================================
@Api : 클래스를 스웨거의 리소스로 표시
@ApiOperation : 특정 경로의 오퍼레이션 HTTP메소드 설명
@ApiParam : 오퍼레이션 파라미터에 메타 데이터 설명
@ApiModelProperty : 모델의 속성 데이터를 설명
@ApilmplicitParam : 메소드 단위의 오퍼에리션 파라미터를 설명
===============================================================

스웨거를 사용시
http://localhost:8080/swagger-ui/
를 사용해야한다.(기본적으로 제공)

Api
ApiOperation
ApiModelProperty
ApiImplicitParams, ApiParam
== 모두 이쁘게 보이기 위해서 사용하는 어노테이션
-> 제목을 부여해주는 어노테이션

ApiResponse
== 오류에 대한 제목을 달아주는 어노테이션