Postman
Postman은 API를 테스트할 수 있을 뿐만 아니라 API를 문서화 또는 공유하여 개발의 생산성을 높여줄 수 있는 플랫폼이다.
API 문서화
collections 생성
request를 그룹화한 단위로 하나의 프로젝트 단위로도 생각할수도 있다.
request 생성
각 request에 대한 정의 해주고 싶을 때 사용
HTTP 메소드, URL, headers 세팅, body 세팅, query string, path parameter에 대한 것들
Variable 생성
Variable 사용
설정한 Variable 사용시 {{}} 기호를 사용
e.g. {{HOST}} -> localhost:9999
request에 대한 서버 응답 예시 저장
request에 대한 서버응답이 왔을 때 해당 응답을 저장할 수 있는 기능이다.
[save response] 버튼을 클릭하여 해당 request 하단에 response를 저장할 수 있다.
collection을 문서형식으로 보기
collection 하위 단위로 작성한 내용들을 한눈에 보기 쉽게 문서형식을 볼 수 있다.
모든 사람들에게 해당 문서 공개
멤버끼리만 공유하고 싶다면 딱히 쓸모없는 기능이지만 멤버가 아닌 남들에게 공유하고 싶다면 publish기능을 사용하면 된다.
- 문서형식으로 보기에서 publish 버튼
- 커스터마이징 할 수 있는 페이지가 나타나고 딱히 필요없다면 publish 버튼을 클릭
- 해당 URL을 공유하면 이제 남들도 해당 문서를 볼 수 있게 된다.
(다시 숨기고 싶다면 unpublish를)
