Swagger

스웨거를 이용하면 API기능을 사용할때, 자동으로 API 문서를 생성해준다.

자바뿐만 아니라 NodeJS, 루비온레일즈 같은 다른 언어도 지원한다고 한다.

build gradle에 의존성을 주입해준다

 

 

apis 메서드 인자로 RequestMapping URL을 설정해줄수있다. 

paths에는 특정 URL만 지정해서 필터링할 수 있다

 

@Api(tags)tag로 해당 URL의 별명을 지정해줄수 있다.

@ApiOperation(value) : API 설명을 적어둔다

모델에 대해서도 설명을 적을 수 있다. Model 역할 파일에 들어간다. 해당 설명을 적고난후

 

실행을 한다.

localhost:8080/swagger-ui.html 을 실행하면 

내가 작성한 API를 문서화하여 보여줍니다.

 

 

API를 문서화 하여 관리하면 스펙을 개발자가 확인하기 편하다. 

또한, 프론트엔드 개발과 협업하게 될 경우, 문서를 전달하여 개발하면 되기때문에 

협업이 좋아진다. 단점은, 현재 프로젝트 API를 기반으로 출력하기 때문에 문서의 버젼관리가 쉽지않다는 점이다.