Swagger
개발자 간 협력에 필요한 API Document를 체계화하는 오픈 소스
- 해당 API에 대한 부연 설명을 Swagger의 어노테이션으로 작성할 수 있다.
@Api : 컨트롤러의 이름을 작성하는 어노테이션
- tags : 굵은 제목 텍스트
@ApiIgnore : 컨트롤러 및 메서드 위에 작성하여 API 문서에서 숨기는 어노테이션
- tags : 굵은 제목 텍스트
@ApiResponse : 각 응답 코드 별로 메시지를 작성할 수 있다.
- code : 응답 코드
- message : 메시지
@ApiParam : 컨트롤러 내 파라미터에 대한 설명을 작성하는 어노테이션
- value : 설명
@ApiModel : Swagger가 적용될 Model(객체 클래스)에 대한 상세한 정보를 작성하는 어노테이션
- value : 값
- description : 설명
@ApiModelProperty : 객체 클래스 속성 값에 대한 설명
- value : 값
@Operation : 메서드 단위로 문서를 편집할 때 사용하는 어노테이션으로 자세한 설명을 작성할 수 있다.
- summary : 제목
- description : 자세한 설명 (markdown 언어 지원)
