Postman을 사용한 POST JSON 전송 방법과 팁 10가지
프로그래밍이나 소프트웨어 개발에 있어 API 테스트는 매우 중요한 과정입니다. 특히, RESTful API와 같은 웹 서비스와의 상호 작용을 수행할 때 JSON 형식을 사용하여 데이터를 전송하는 경우가 많습니다. Postman은 이러한 작업을 쉽게 수행할 수 있도록 도와주는 도구로, 완벽하게 설정된 인터페이스를 제공합니다. 이 글에서는 Postman을 사용하여 POST 요청을 통해 JSON 데이터를 전송하는 방법을 소개하고, 작업을 보다 효과적으로 수행할 수 있는 10가지 유용한 팁을 공유할 것입니다.
Postman 설치 및 설정
먼저 Postman을 설치하려면 해당 웹사이트에서 다운로드하여 설치합니다.
- Postman 공식 웹사이트로 이동합니다.
- 운영체제에 맞는 버전을 선택하여 다운로드합니다.
- 설치 후 Postman을 실행합니다.
Postman을 처음 사용할 경우, 계정을 생성하여 로그인하면 여러 기능을 활용할 수 있습니다. 하지만 로그인 없이도 기본적인 API 테스트는 가능합니다.
1단계: 새로운 요청 생성
Postman을 실행한 후 다음 단계를 따라 새 요청을 생성하세요.
- Postman의 왼쪽 사이드바에서 "New" 버튼을 클릭합니다.
- **"HTTP Request"**를 선택합니다.
- 요청 이름과 설명을 입력한 후 **"Save"**를 클릭합니다.
- 요청 유형에서 **"POST"**를 선택합니다.
2단계: 요청 URL 입력
POST 요청을 보낼 API의 엔드포인트 URL을 입력합니다. 예를 들어, JSONPlaceholder라는 가상의 API를 사용해보겠습니다.
https://jsonplaceholder.typicode.com/posts
적절한 URL을 입력한 후, 요청의 본문을 작성하기 위해 "Body" 탭을 선택합니다.
3단계: JSON 데이터 작성
"Body" 탭 내에서 **"raw"**를 선택하고, **"JSON"**을 선택합니다. 이후 JSON 형식에 맞는 데이터를 입력합니다. 다음과 같이 입력할 수 있습니다:
{
"title": "foo",
"body": "bar",
"userId": 1
}
4단계: 요청 헤더 설정
POST 요청을 서버에 전송할 때는 콘텐츠 유형을 지정해야 합니다. 이를 위해 "Headers" 탭으로 이동하여 다음과 같이 헤더를 추가합니다.
| Key | Value |
|---|---|
| Content-Type | application/json |
이렇게 하면 서버에 JSON 형식의 데이터를 보낸다고 명시하는 것입니다.
5단계: 요청 전송
모든 설정이 완료되었다면, "Send" 버튼을 클릭하여 요청을 전송합니다. Postman은 요청 결과를 하단의 "Response" 섹션에 표시합니다.
6단계: 응답 확인
성공적으로 POST 요청을 보내면, 응답으로 서버에서 전송한 데이터를 확인할 수 있습니다. JSONPlaceholder의 경우, 데이터가 입력된 ID를 포함하여 회신됩니다.
{
"id": 101,
"title": "foo",
"body": "bar",
"userId": 1
}
팁 1: 환경 변수 사용
Postman에서 환경 변수를 사용하면 API 요청을 더 유연하게 관리할 수 있습니다. API URL이나 인증 토큰 등 반복적으로 사용되는 값들을 변수로 설정해 두면 코드의 가독성을 높이고 관리가 용이해집니다.
- 오른쪽 상단의 환경 드롭다운에서 **"Manage Environments"**를 선택합니다.
- 새로운 환경을 추가하고 변수를 입력합니다.
예를 들어, 환경 변수를 아래와 같이 설정할 수 있습니다.
| VARIABLE | INITIAL VALUE |
|---|---|
| base_url | https://jsonplaceholder.typicode.com |
이제 요청 URL을 ${base_url}/posts와 같은 형식으로 사용할 수 있습니다.
팁 2: 폴리시 추가
Postman에서는 요청에 대해 폴리시를 추가하여 재사용성을 높일 수 있습니다. API 요청을 자주 사용하는 경우, 폴리시를 통해 동일한 설정으로 여러 요청을 한꺼번에 처리할 수 있습니다.
- "Collections" 탭에서 새로운 컬렉션을 만듭니다.
- 이전에 만든 POST 요청을 컬렉션에 추가합니다.
이제 해당 컬렉션을 선택하면 필수적인 모든 요청을 그룹으로 처리할 수 있습니다.
팁 3: 테스트 스크립트 사용
Postman에서는 요청 후 원하는 결과가 나타나는지 확인할 수 있도록 테스트 스크립트를 작성할 수 있습니다. 바디에는 다음과 같은 JavaScript 코드를 입력해 보세요:
pm.test("Response status should be 201", function () {
pm.response.to.have.status(201);
});
pm.test("Response body should be a JSON", function () {
pm.response.to.be.json;
});
위 스크립트는 응답 상태 코드가 201인지, 응답 본문이 JSON 형식인지 확인합니다.
팁 4: 요청 변수화
특정 요청에 사용되는 데이터를 변수화하면 편리합니다. 예를 들어, 사용자 ID나 요청의 본문에 포함되는 값을 변수로 설정할 수 있습니다. 본문 데이터를 아래와 같이 수정하면 됩니다.
{
"title": "{{title}}",
"body": "{{body}}",
"userId": {{userId}}
}
그러면 요청 변수에서 해당 값들을 미리 설정해두면 사용이 가능합니다.
팁 5: 요청 미리보기 기능
Postman은 요청을 보낼 준비가 되었을 때, "Preview" 기능을 통해 요청의 최종 상태를 미리 볼 수 있는 기능을 제공합니다. 이를 통해 어떤 데이터가 서버에 전송되는지 쉽게 확인할 수 있습니다.
팁 6: 인증 방식 설정
POST 요청을 보낼 때, 인증이 필요한 경우가 많습니다. 예를 들어, Bearer 토큰을 사용하는 경우 다음과 같은 방법으로 설정할 수 있습니다.
- "Authorization" 탭으로 이동합니다.
- "Type" 드롭다운에서 **"Bearer Token"**을 선택합니다.
- 토큰을 입력합니다.
이제 요청을 보내면 Postman이 자동으로 Head에 인증 정보를 포함합니다.
팁 7: 이전 요청과 비교하기
Postman은 이전 요청과 현재 응답을 비교하거나 이전 응답을 사용하여 테스트할 수 있는 기능을 제공합니다. 이러한 기능을 활용하면 작은 디버깅 작업이 한층 더 간편해집니다.
팁 8: History 기능 활용
Postman은 요청의 히스토리를 저장합니다. 이전에 보낸 요청을 쉽게 찾아볼 수 있으며, 필요에 따라 재사용할 수도 있습니다. 요청 히스토리는 왼쪽 사이드바에서 쉽게 탐색할 수 있습니다.
팁 9: Mock 서버 생성
Postman에서는 Mock 서버를 통해 서버 없는 상태에서 API를 테스트할 수 있습니다. 이를 통해 API 디자인 단계에서 문제를 사전에 발견하고 수정할 수 있습니다.
- **"Mock Server"**를 선택합니다.
- API 정의를 기반으로 Mock 서버를 생성하고 필요한 응답을 설정합니다.
팁 10: 팀과의 공유
Postman은 협업 기능을 제공합니다. 팀에서 요청과 응답을 공유하고, 협력하여 API 개발 및 테스트 작업을 진행할 수 있습니다. 이를 통해 정보의 일관성을 유지하고 팀워크를 극대화할 수 있습니다.
이와 같이 Postman을 사용하면 POST 요청을 통해 JSON 데이터를 손쉽게 전송할 수 있으며, 다양한 팁들을 활용하여 작업 효율성을 극대화할 수 있습니다. Postman의 다양한 기능을 잘 활용하면 API 테스트와 개발이 훨씬 수월해질 것입니다.
결론
Postman을 활용한 POST 요청을 통해 JSON 데이터를 전송하는 방법과 유용한 팁들을 소개했습니다. 이 과정은 API 테스트 및 개발 과정에서 중요한 부분으로, Postman의 다양한 기능을 효과적으로 활용하면 작업의 효율성과 정확성을 높일 수 있습니다. 새로운 요청을 생성하고, 올바른 URL을 입력하는 것에서부터, JSON 데이터를 작성하고 요청 헤더를 설정하는 단계까지 상세히 설명하였습니다. 더불어 환경 변수 사용, 폴리시 추가, 테스트 스크립트 작성 등 다양한 팁을 통해 Postman을 보다 유연하고 효과적으로 활용할 수 있는 방법을 제안하였습니다. API 개발자 및 테스터 여러분은 이번 글을 통해 소개된 방법과 팁들을 참고하여 보다 효율적인 API 구축 및 관리를 경험해 보시기를 바랍니다. Postman을 통해 API 테스트의 새로운 가능성을 열어가세요!