swagger-ui 사용법

스웨거란 RESTAPI 개발시 문서를 자동으로 만들어주는 프레임워크이다.

대부분 API 를 Request 날릴때 사용을 하곤 한다.

저번에 다뤘던 내용인 postman을 사용해도 되고 이 swagger를 사용해도 좋다.

postman 사용은 아래 참고 포스팅을 확인해보면 된다.

 

자바 뿐 아니라 python이나 nodejs 에서도 사용은 가능하지만 자바 스프링에서 사용할수 있는 좋은 기능이기에 자바 카테고리로 분류를 하였다.

 

 

사용을 하려면 먼저 라이브러리를 추가해야한다.

maven 경우

gradle 경우

그리고 자바 소스로 와서 swaggerconfig 파일을 생성해준다.

 

기존에는 여기서 되었는데 좀더 확인을 해보니 configuration 파일에 추가 설정을 해줘야했다.

그래서 변경된 코드는 아래와 같다.

이렇게 추가가 되는 이유는 maven에서 라이브러리를 받아오면 아래 사진과 같은데

여기에서 경로를 못잡기에 configuration에 추가를 해준 작업니다.

 

이렇게 까지만 해도 localhost:8080/swagger-ui.html로 접속해보면 API문서가 생긴것을 확인해볼수 있다.

 

추가로 API를 만들수도 있고,

기능에 따라 URI 주소를 변경해서 사용도 가능하니 사용을 하면서 익히는 연습이 필요할 듯 하다.

---

참고 포스팅

https://thenicesj.tistory.com/190

Postman 이란?