Web/Spring Boot
2021. 4. 12.
[Spring] Swagger2을 사용하여 API 문서 자동화 하기
오늘은 gradle을 사용한 Spring 환경에서 Swagger을 사용하여 API문서를 자동화하는 방법에 대해 작성하고자 한다. Swagger란? Swagger는 Rest API서버 구현 시 사용하는 API 정보를 자동으로 문서화해주는 오픈소스 프레임워크이다. Swagger을 사용하는 이유? Swagger을 사용하는 이유는 다음과 같다. 1. 적용하기 쉽다. - 코드 몇줄을 추가하여 Swagger을 사용 할 수 있다. 2. 테스트를 할 수 있는 UI을 제공해준다. - API을 테스트 할 때 주로 Postman을 사용하여 테스트를 할 수 있지만 Swagger의 경우 GUI로 테스트를 할 수 있는 환경을 제공한다. 3. 다양한 프레임워크를 지원하여 (Spring, Django, Node.js 등등) - AP..
![[Spring] Swagger2을 사용하여 API 문서 자동화 하기](http://i1.daumcdn.net/thumb/R450x0/?fname=https://blog.kakaocdn.net/dn/bb3Ste/btq2s5eiB5m/zZcU6dxFEIVsQHPvlOyVRK/img.png)