구글 스프레드 시트를 이용해 API 명세서를 작성하면 작성된 명세서에 있던 오탈자로 인해 클라이언트 측에서 상당 시간을 낭비할 수도 있고 가시적이지 못하다.

API 명세서의 개념

• API 사용자는 어떤 정보를 전달받을 수 있는지 어떤 방식으로 요청해야하는지, 어떤 형식으로 데이터가 넘어오는지 알 수 없다. 그래서 제공하는 사람들은 데이터뿐만 아니라 API 문서를 같이 제공해야 한다. API 명세서를 이용하면 클라이언트가 서버에서 제공하는 데이터를 어떻게 사용할 수 있는지 알 수 있다.

Swagger란

• Swaager란 개발한 Rest API를 편리하게 문서화 해주고, 이를 통해서 관리 및 제 3의 사용자가 편리하게 호출해보고 테스트 할 수 있는 프로젝트이다.

즉 Swagger는 API 문서화를 자동으로 해주고 API를 문서 화면에서 바로 테스트할 수 있는 오픈 소스임