Postman: API 테스트 도구

1. 개념
2. 주요 기능
3. 사용 방법

개념

• API(애플리케이션 프로그래밍 인터페이스)를 설계, 테스트, 디버깅, 문서화, 및 공유하는 데 사용되는 강력한 도구
• 특히 RESTful, GraphQL, SOAP 등의 다양한 API를 쉽게 다룰 수 있도록 직관적인 UI와 유용한 기능들을 제공
  Postman API Platform

주요 기능

1. API 요청 테스트

• 다양한 HTTP 메서드(GET, POST, PUT, DELETE 등)를 사용하여 API 요청을 보낼 수 있음
• 요청 헤더, 본문, URL 파라미터 등을 자유롭게 설정 가능.
• 응답 상태 코드, 본문, 헤더 등을 확인하며 API 동작을 검증.

2. 환경 변수 관리

• 개발, 스테이징, 프로덕션 등 여러 환경을 위한 변수를 설정하여 API 테스트를 유연하게 실행할 수 있음.
  예: {{baseUrl}}를 사용하여 환경에 따라 URL을 동적으로 변경.

3. 콜렉션(Collection)

• API 요청을 그룹화하여 저장, 공유, 재사용 가능.
• 테스트를 자동화하거나 문서화하는 데 유용.

4. 테스트 자동화

• JavaScript를 사용하여 요청 후 응답 데이터를 검증하는 스크립트를 작성 가능.
• 예: 상태 코드가 200인지 확인하거나, 특정 응답 값의 유효성을 체크.

5. Mock 서버 생성

• 실제 API가 준비되지 않아도 Mock 서버를 생성하여 프론트엔드 개발 등을 진행할 수 있음.

6. API 문서화

• API 콜렉션을 기반으로 자동화된 문서를 생성해 팀원 또는 클라이언트와 공유 가능.

7. 협업 기능

• 팀 작업을 위해 Postman 워크스페이스에서 API 요청, 테스트, 환경 설정 등을 공유 가능.
• 실시간으로 변경 사항을 반영하고 협력.

8. 통합 기능

• Jenkins, GitHub, Slack 등 다양한 도구와 통합 가능.
• CI/CD 파이프라인에 쉽게 포함할 수 있음.

사용방법

1. 설치 및 실행

• Postman 공식 웹사이트에서 앱을 다운로드하거나 웹 버전으로 바로 실행.

2. 새 요청 생성

• HTTP 메서드 선택 (예: GET)
  URL 입력 (예: https://api.example.com/resource)
  필요한 헤더, 본문, 인증 정보 설정.

3. 요청 실행 및 응답 확인

• "Send" 버튼을 클릭하여 요청 전송.
  응답 상태 코드, 본문(JSON, XML 등), 헤더를 확인.

4. 콜렉션 생성 및 관리

• 여러 API 요청을 그룹화하여 관리.
  반복적인 작업 자동화.

5. 테스트 작성

• 요청의 응답을 기반으로 테스트 스크립트를 작성.

pm.test("Status code is 200", function () {
  pm.response.to.have.status(200);
});