[Tools] POSTMAN

POSTMAN은 API를 ✅개발, ✅테스트, ✅공유 및 ✅문서화할 때 사용되는 API 클라이언트다. POSTMAN은 개발된 API를 테스트하고, 테스트 내용을 통해 API를 문서화할 수 있는 기능을 제공한다. 또한 Collection을 통해 사용했던 API와 테스트 내용을 저장해두고, 편하게 테스트 및 개발을 할 수 있다.

1. Collection 생성

💡 Collection

• Collection은 모든 HTTP Request(요청)를 포함하는 단위이다. Project와 비슷한 맥락으로 이해하면 좋을 것 같다.
• Collection 내에 작성된 모든 API를 한번에 테스트할 수 있다.
• Collection 내에 작성된 내용은 API Document에 자동으로 적용된다.

• + 버튼을 사용해 새로운 Collection을 추가할 수 있다.
• 밑줄 쳐져있는 부분은 Collection의 이름이다.

2. Folder 생성

💡 Folder

• Folder는 HTTP Request(요청)를 세분화할 수 있는 기능이다.
• API Document에서 Folder 별로 간단한 Description을 작성할 수 있는 기능을 제공한다.

• ...을 클릭하고, Add folder 메뉴를 선택하면 Folder를 생성할 수 있다.

3. Request 생성

💡 Request

• Request는 HTTP Method부터 Parameter, Body Type(JSON 등), Header(Key, Value) 등을 지정할 수 있다.
• Enviroment 메뉴를 통해 여러 변수를 설정할 수도 있다.

• ...을 클릭하고, Add request 메뉴를 선택하면 Request를 생성할 수 있다.

😕 그림판 발퀄 ㅈㅅ;;

1. HTTP Method를 설정한다.
2. Request(요청)을 보낼 URL을 설정한다.
3. Header의 내용을 설정한다.
4. Body의 내용을 설정한다.
5. Body의 입력 방식(Text, JS, JSON 등)을 설정한다.

4. Response 확인

💡 Response

• Request(요청)을 전송함으로써 Response(응답)을 직관적으로 확인할 수 있다.
• Save Response 메뉴를 통해 Request(요청)과 Response(응답)을 저장하고, API Document에 포함시킬 수 있다.

• Save Response 메뉴를 선택해 API Documet에 내용을 포함할 수 있다.

• API Document 우측에 보이는 것처럼, 저장된 Response 내용을 전부 확인할 수 있다.

5. API Document 생성

• Collection의 ...을 클릭하고, View Documentation 메뉴를 선택하면 API Document를 편집할 수 있다.
• Markdown 언어를 지원한다.