Postman ?
API를 구축하고 사용하기 위한 플랫폼.
API를 사용하기 위한 플랫폼으로 이용하거나, API 명세를 외부에 공개하기 위한 Documentation 용도로 사용 중.
Navigation
강력한 플랫폼이고, 그에따른 기능도 굉장히 많다.
Client 입장에서 개발을 진행하고 있기 때문에, '사용법'에 대해 간략하게 기술.
1. History ?
Postman으로 이용했던 Request 목록이 확인 가능하고, 클릭하면 재사용 가능.
Postman에 로그인해놓았다면, 계정 단위로 History 공유가 가능. 업무 기기가 여러개라면 로그인 해놓으면 좋다.
다수의 항목을 선택하려면 Window Ctrl(or MAC Command) 키를 이용하여 클릭.
2. Collections ?
Client 입장에서 API를 테스트하게 된다면, 가장 많이 사용하는 탭.
API를 요청할 때 마다, 탭을 1회성으로 만들지 말고 Collection을 생성해서 재사용할 것을 권장 함.
상단 스크린샷을 보았을 때, Http Method/URL/Variables/Parameter 등 'API 단위로 템플릿'을 저장하여 관리 가능.
또는, 문서형태로 웹에 배포하는 기능을 포함하고 있기 때문에, 내부 API 명세를 외부에 공개하기 위한 용도로 사용 가능.
(Swagger등을 외부에 공개하는건 부담스럽기 때문에, 따로 Postman을 이용하여 Documentation을 하곤 했다.)
Description
설명 ! 디스크립션 ! 추가 설명 필요 없음.
Authorization
API 서버에서 클라이언트의 정합성을 검증하고 있다면 사용. 고정 된 OAuth2 등 설정 가능.
개인적으로는.. 대규모 IT 조직 외에는 Auth가 제대로 구현한 경우를 본적은 드물다.
보통은 요청 템플릿의 Header를 직전 한땀한땀 지정해서 사용하곤 했다.
Pre-request Scripts
Reqeust 이전에 실행될 트리거를 지정할 수 있다.
Javascript로 작성되며, 디버깅에 자동화가 필요한 경우에 주로 사용.
Tests
Test Code! API 실행 이후에 실행될 트리거를 지정한다.
일반적으로 생각하는 Test Code들이 이쪽에 작성되고, 마찬가지로 Javascript로 작성한다.
Postman:: writing-scripts/intro-to-scripts
Pre-request Scripts, Tests에 대한 작성법은 공식 문서에 상세히 설명되어있다.
Variables
템플릿에서 자주 사용되는 변수들 관리.
개인적으로는 Production/Development 환경에 따라 종속되는 변수들을 관리하고 있다.
(API HOST, Basic Auth 등..)
3. APIs ?
API Builder.
(동료들과 협업하면서) API를 설계하고, 문서화하고, 테스트 코드를 통해 정합성을 보증하는 등의 Rest API 개발에 필요한 일련의 과정들을 하나의 세트로 제공.
템플릿 코드 형태로 저장되기 때문에, Git을 통한 형상관리도 가능
Collection은 단일 Request에 대한 관리, APIs는 API 생태계(?)에 대한 통합적인 관리.
(하지만 현업에서 본격적으로 사용해본적은 없다. 협업 툴로 사용하는 곳이 있다면 한번쯤은 구경해보고 싶다.)
Etc.
Postman:: Navigating Postman
전반적인 화면 구성은 공식 문서 참조.
