Swagger

API Documentation & Design Tools for Teams

원래라면 BE와 FE 개발자간 소통을 위한 Documentation & Design Tool 일 수 있겠지만 우리 팀은 너무나도 작은 소규모고 Agile 방식으로 구분 없이 정해진 일정에 맞춰 Sprint를 달리는 방식이라 Postman에 저장하고 공유할 때가 많았다.

 

그럼에도 Swagger가 필요하다고 외치게 된 이유는, 특정 API들을 Live 환경에서 호출해야하는데 CURL로 하기엔 인증을 위한 Header나 Parameter를 작성하기엔 어려움이 있다고 생각 됐기 때문이다.

 

전부다 할 필요는 없었고 필요한 기능만 Swagger Doc을 통해 주석과 같은 형태로 담고 만든 기능들을 코드에 포함시켜 형상관리를 했고 외부에 노출 시키지 않고 로컬 환경에서 go-swagger 를 이용해 서버 주소만 바꿔가며 Live, QA, Dev 등 원하는 환경을 변경해서 이용했다.

 

나중에 신규 프로젝트에선 API first design - IDL protobuf에 정의하면서 자동으로 Swagger가 기본적으로 만들어지긴 했는데 사실 IDL 소스코드를 봐도 한눈에 잘 보여서 Swagger는 잘 안봤다.