[포스트맨] REST API를 보다 잘 정리하게 돕는 기능들

구조 설명

1. Workspace

• 가장 최상위 Workspace 입니다.
• 다수의 Collection의 집합입니다.

2. Collection

• Workspace 하위 폴더 입니다.
• 보통 프로젝트 이름 혹은 서버와 1:1 관계입니다.

3. Folder

• 보통 Controller 기준으로 분리 합니다.

4. Request

• API 엔드포인트를 정의합니다.

Postman 기능 소개

포스트맨은 본질적으로 API Testing Tool 이지만 API 문서화 및 버전 관리의 의미도 큽니다. 특히 개발자 간의 소통을 줄여주는 도구로써 아주 유용하게 쓰이고 있습니다.

본 문서는 개발자 대상으로 작성하는 문서이기 때문에 테스트에 관해서는 자세히 언급을 하지 않겠습니다.

환경 변수 설정 기능

• 해당 기능은 baseUrl, 만료 기간이 없는 Super Token 과 같이 고정된 값을 변수로 활용 할 수 있게 해주는 설정 기능입니다.

• 예를 들어 local, 개발 서버, 운영 서버와 같이 baseUrl의 수정이 빈번할 때 변수로 사용함으로써 이 기능을 활용 할 수 있습니다. 위와 같이 baseUrl 만 두고 환경변수만 바꾸면서 작업이 가능하게 됩니다.

Request Doc 기능

• 각 REST API 마다 필요한 Request Param 에 대한 설명 등에 활용 될 수 있습니다.
• Back-end 개발자만 알고 있는 특이사항 혹은 Front-end 언어 스텍과 Back-end 언어 스텍이 달라 타입 표현이 모호 할 때 활용 하면 좋습니다.

Request 댓글 기능

• 위 스크린샷과 같이 간단한 Comment만 남겨주더라도 버전 관리에 굉장히 용이합니다.

Request Example 기능

• API 는 기본적으로 응답이 항상 일정 할 수 없습니다. 따라서 성공과 실패 혹은 다른 특수한 경우가 존재하는 API 일 경우 Example을 두어 관리하면 편합니다.