용로그
article thumbnail
[API] 좋은 협업과 API를 위한 답 없는 고민들
Web 2023. 7. 5. 19:55

들어가기 전 최근 프로젝트를 진행하면서, API 명세에 대한 이야기를 많이 나누었다. API가 점점 늘어나고, 프론트와의 협업이 다가오면서 점점 API 문서화의 필요성을 실감하게 된다. API를 사용하는 곳은 정말 많다. 로컬 환경 뿐만 아니라 개발(dev), 운영(prod) 환경에서 API 요청이 잘 되는지 확인을 해야할 때도 있다. 또한 API의 스펙자체를 문서화 해놓지 않는다면, 프론트엔드 개발자와의 협업이 정말 힘들어질 것이다. 이번 글에서는 현재 진행중인 프로젝트에서 어느 부분을 고려해서 어떤 API를 어떻게 문서화, 테스트했는지 소개하겠다. 나름 개발 좀 해봤다 하면 들어봤을 만한 툴들을 기준으로 많이 알아보자. 이 글은 어떤 API 문서와 테스트 툴을 사용할지에 대한 고민이 담긴 글이기 때문..