swagger가 필요한 이유와 정리
개요
API를 문서화 시키는 것은 상당히 중요한 작업입니다. 여러 API들을 개발했다 하더라도 문서화가 되어있지 않거나 제대로 작성되지 않았더라면 API를 사용하는 이점이 줄어들 뿐만 아니라 제대로 사용하기 불가능하기 때문에 이러한 API들을 잘 작성하는 것에도 꽤 시간을 투자해야 합니다.
이러한 불편함과 어려움들을 많이 줄여주는 API 문서자동화 도구(프로젝트 파일에 형식을 지켜 작성해놓으면 이를 바탕으로 자동생성함) 시키면 자동으로 가 있는데 그것을 swagger라고 합니다
간단한 설정으로 프로젝트에서 지정한 URL들을 HTML 화면으로 확인할 수 있게 해주는 프로젝트입니다. Swagger를 활용해서 API 명세를 작성한다면, 보다 쉽게 API 명세를 작성할 수 있습니다. https://overcome-the-limits.tistory.com/101
이러한 작업을 통해 서버개발자와 효율적인 소통을 가능하게 하고 문서작업을 하는 시간이 줄어들게 됩니다.
https://github.com/bjc1102/swagger-test
