semtax의 개발 일지

개요 이번 포스팅에서는, Swagger를 이용해서 REST API 문서를 자동으로 생성하는 법을 다루려고 한다. ​ ​ ​ ​ 문서화의 중요성 한가지 상황을 가정해보도록 하자. ​ ​ 만약 여러분이 프론트 개발자, 다른 팀에서 만들어진 REST API를 사용 해야하는 입장의 개발자라고 가정을 해보자. 이때, 프로젝트가 다 됬다고 듣고, API를 사용하려고 봤는데 어떻게 사용하는지에 대한 메뉴얼을 주지 않아서 사용방법을 알아내기 위해 저 API를 개발한 직원을 직접 부르거나 여러분이 직접 저 코드들을 분석해서 사용방법을 알아내느라 1~2주가 소요 되어버렸다. 상상만 해도 정말 끔찍하다. 이런 상황을 어떻게 극복하면 좋을까? ​ ​ ​ ​ 위와 같은 상황을 방지해주기 위해, 저러한 API를 만들고 나서는 A..