[Spring] Swagger - REST 웹 서비스의 문서화

# Swagger 란? 

• REST 웹 프로젝트를 문서화 해주며, 이를 통해 관리 및 다른팀원들이 편리하게 API를 호출해보고 테스트 할 수 있는 프레임워크이다. 

---

# Spring Fox Swagger 사용법 

1. Maven Repository 에서 Spring Boot Starter 검색 후 build.gradle 에 dependencies 추가

• https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter/3.0.0

 

 2. 프로젝트 실행 후, 설정된 도메인주소/swagger-ui/ 로 접속.

   (local 환경이라면 http://localhost:포트번호/swagger-ui/)

---

# Swagger Annotation

Annotation	적용대상 및 위치	기능
@Api	클래스	클래스에 대한 사용자정의 설명
@ApiOperation	메소드	메소드에 대한 사용자정의 설명
@ApiResponse	메소드	메소드의 response 코드에 대한 설명 (신규 code 를 작성해 설명을 달 수 있다.)
@ApiParam	메소드의 개별 매개변수 (1개)	매개변수에 대한 사용자정의 설명
@ApiImplicitParams	메소드	배열로 매개변수에 대한 사용자정의 설명
@ApiImplicitParam	@ApiImplicitParams 내부에 작성	매개변수 1개에 대한 설명
@ApiModelProperty	DTO 객체의 멤버변수	멤버변수에 대한 설명

---

# Swagger Documentation

• https://swagger.io/docs/

Swagger Documentation