처음 개발하거나 혹은 유지보수를 진행할 때, API 서버가 어떤 스펙을 가진 데이터를 주고받는지에 대한 문서작업이 꼭 필요함.
뭇너작업은 굉장히 시간이 많이들고, API가 수정될 때마다 문서도 같이 수정해줘야 하는 번거로움을 동반함.
Swagger 는 Open API Specification(OAS)를 위한 프레임워크 API 들이 가지고 있는 스펙을 명세, 관리할 수 있는 프로젝트
Swagger Annotation으로 swagger-ui 보강
@ApiOperation Annotation
-API 메소드에 대한 설명을 추가 할 수 있음.
@ApiImplicitParams Annotation
- DTO 상세 파라미터의 설명을 추가하거나 필수 파라미터, Data Type, 파라미터 Type을 설정.
@ApiModelProperty Annotation
- 파라미터의 Example value를 설정 가능
즉, Swagger-ui에는 property로 매핑되고 DTO에서는 properties로 매핑된다.
