API문서 작성 및 테스트의 필요성 - 원활한 소통을 위하여
개발은 혼자하기 어렵다. 따라서 다른 개발자들과 협업 시, 가장 중요한 것 중에 하나는 '소통'이다. 이러한 소통을 쉽게 가능하게 해주는 것이 '읽기 좋게 문서화'하는 것이다. 특히 백엔드 개발자에게 API 문서 작성은 가장 기본적인 임무이자 실력이라고 한다. 좋은 API문서 작성을 위해 다양한 도구들이 있지만 Postman을 활용하여 시작해보려고 한다.
1. Collection 생성
Collection에 들어가서 '+'를 누르면 'New Collestion'이 생성된다.
2. request 생성
New Collection에서 오른쪽 점점점을 누르고 Add request를 선택한다.
다음과 같이 request를 작성할 수 있는 공간이 생성된다.
3. request를 작성하고 response 저장하기
원하는 메소드를 선택하고 주소를 작성한 후, Send 버튼을 눌러 요청을 보내준다.
받은 응답을 저장한다.
다음과 같이 저장하고 이름을 넣어줄 수 있다.
4. API문서화 하기
New를 버튼을 눌러 API Documentation을 선택한다.
문서화할 Collection을 선택한다.
문서에 대한 정보를 작성한 후, 저장한다.
view document 버튼을 눌러 생성된 문서를 확인한다.
Publish 버튼을 누른다.
표시된 링크를 가보게 되면...
다음과 같이 작성된 API 문서를 확인할 수 있다.
마무리
포스트맨을 통해 API문서를 작성하는 법을 알아보았다. 개발자에 한걸음 더 다가선 것 같은 느낌을 크게 받는다.
참고 링크는 다음과 같다.
우물에서 자라나는 중