<aside> 💡 RESTFul API란 ? REST의 원리를 따르는 API URI(Uniform Resource Identifier)를 통해 자원(Resource) 명시 HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation 적용 자원을 정의하고 자원에 대한 주소를 지정하는 방법 **https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html **https://meetup.toast.com/posts/92**
</aside>
협업 또는 이미 만들어져 있는 프로젝트를 유지보수 해야 하는데
API 문서를 손으로 하나하나 작성하다 보면.. 내가 문서를 작성하는 건 지 문서가 나를 작성하는 건 지..
API 수정이 생길 때마다 문서도 같이 업데이트 해줘야 하고.. 정말 힘듭니다.
혹시 깜빡하고 API와 문서 싱크가 안 맞으면 모두에게 혼란을 야기할 수도 있습니다.
Swagger는 그 불편함을 확연하게 줄여줍니다.
내가 하나하나 작성하지 않아도 되니까!
Swagger는 다양한 Tool을 지원하고 있습니다. 먼저 저희가 사용 하게 될 Swagger UI 입니다.
Swagger UI : 세팅만 해주면 API를 읽어 html 페이지를 제공 해 줍니다.
기존 API에 Swagger를 적용하면 보이는 html 페이지