Postman 스크립트를 사용해 API 인증 과정 단순화하는 법

기사 원문: How to Use Postman Scripts to Simplify Your API Authentication Process

Postman은 개발자, API 테스터, 기술 문서 작성자, DevOps 팀이 API 개발을 테스트하고 문서화하며 협업할 때 사용하는 플랫폼입니다. HTTP, GraphQL, gRPC 등 다양한 형태의 API 요청을 손쉽게 만들고, 응답을 확인하며, API 요청들을 컬렉션 형태로 구성해 협업과 자동화를 지원합니다.

API 테스트 과정에서 반복 작업을 수행하는 일은 스트레스도 크고 시간이 많이 소요됩니다. 특히 Postman에서 새 인증 토큰을 받아 복사해서 붙여넣는 작업은 매우 반복적입니다. Postman 스크립트를 사용하면 인증 토큰을 자동으로 저장하고 재사용할 수 있어 이러한 반복 작업을 줄일 수 있습니다.

이 가이드를 따라 해보려면 다음이 필요합니다:

Postman API 클라이언트가 설치된 컴퓨터
Postman으로 API 요청을 만들어본 경험
JWT 인증을 사용하는 백엔드 애플리케이션과 해당 API 문서

만약 백엔드 애플리케이션이 없다면, 제가 GitHub에 올려 둔 예제(orimdominic/freeCodeCamp-postman-api-jwt)를 클론해서 사용할 수 있습니다.

이 글을 다 읽고 나면, Postman에서 인증 토큰을 발급 / 저장 / 재사용하는 과정을 훨씬 단순화할 수 있습니다. 또한 Postman의 다른 테스트 자동화 작업에도 활용할 수 있는 실용적인 스크립트 개념을 익히게 될 것입니다.

Postman 스크립트란?

Postman 스크립트는 Postman API 클라이언트 내부에서 실행되는 JavaScript 코드로, API 테스트 워크플로우를 자동화하고 확장하는 데 사용합니다. 스크립트는 요청 전(pre-request)과 요청 후(post-response)에 실행되도록 추가할 수 있습니다. 스크립트를 사용하면 다음과 같은 작업이 가능합니다:

API 요청 데이터를 처리하는 로직 추가
API 응답에 대한 테스트(assertion) 작성
API 엔드포인트 자동화 테스트 실행

Postman의 Scripts 탭에서 스크립트를 확인할 수 있습니다. Pre-request 탭은 요청이 실행되기 전에, Post-response 탭은 응답이 온 뒤에 실행됩니다.

JWT 인증 과정을 단순화하는 방법

이번 튜토리얼은 다음과 같은 순서대로 진행됩니다:

인증하여 토큰 발급받기
스크립트를 사용해 토큰을 컬렉션 변수에 저장하기
API 요청에서 해당 변수를 사용하기

인증하여 토큰 발급받기

다음과 같은 순서대로 따라해보세요:

백엔드 애플리케이션을 실행하고 정상적으로 동작하는지 확인합니다.
Postman을 열고 JWT를 발급받는 로그인(sign-in) 요청으로 이동합니다.
로그인 엔드포인트에 API 요청을 보내고 JSON 응답 구조를 확인합니다.

위 이미지에서 하이라이트된 부분은 로그인 요청이 성공했을 때 반환되는 JSON 응답을 보여줍니다. 이 응답 스키마에서 인증에 사용할 토큰은 data.token 필드에 포함되어 있습니다. 이제 이 토큰을 Postman 스크립트를 사용해 변수로 저장한 뒤, 인증이 필요한 요청의 Authorization 헤더에서 해당 변수를 사용하게 될 것입니다.

스크립트를 사용해 토큰을 컬렉션 변수에 저장하기

Postman에서 Body 탭 옆에 있는 Scripts 탭을 클릭합니다. 만약 Postman 창이 작게 표시되어 있다면, 해당 탭이 드롭다운 메뉴 안에 있을 수 있으니 펼쳐서 확인합니다. 다음으로 Post-response 탭을 선택합니다. 오른쪽의 텍스트 영역에 응답에서 인증 토큰을 추출해 Postman 변수에 저장하는 스크립트를 작성하게 됩니다. 아래 JavaScript 코드를 복사해 이 텍스트 영역에 붙여 넣습니다.

if (pm.response.code == 200) {
    const token = pm.response.json().data.token
    pm.collectionVariables.set("auth_token", token)
}

Postman 스크립트에서는 pm 식별자를 사용해 Postman 환경의 정보에 접근하고 값을 수정합니다. 위 스크립트는 먼저 응답 상태 코드가 200인지 확인해 요청이 성공했는지 확인합니다.

조건문 내부에서는 pm.response.json().data.token을 사용해 JSON 응답에서 인증 토큰을 가져오고, 이를 auth_token이라는 컬렉션 변수에 저장합니다. 만약 auth_token 변수가 없다면 새로 생성되고, 이미 존재한다면 기존 값이 새 토큰 값으로 덮어씁니다.

토큰이 변수에 정상적으로 저장되었는지 확인하려면, 위 스크린샷 기준으로 먼저 컬렉션 이름(1)을 클릭한 뒤 Variables 탭(2)을 선택합니다. 이후에는 인증 토큰을 매번 복사해 Authorization 헤더에 붙여넣을 필요 없이, Authorization 헤더에서 auth_token 변수를 그대로 사용할 수 있습니다.

API 요청에서 해당 변수를 사용하기

Authorization 헤더에서 컬렉션 변수를 사용할 때는 {{auth_token}}처럼 중괄호 두 개로 감싸서 참조합니다. 이렇게 설정해두면, API 요청을 보낼 때 Postman이 {{auth_token}}에 저장된 값을 자동으로 Authorization 헤더에 넣어 사용합니다.

또 다른 인증 요청으로 인해 auth_token 값이 갱신되더라도, 새로운 토큰을 직접 복사해서 붙여넣을 필요는 없습니다. Post-response 탭에 작성한 스크립트가 자동으로 auth_token 값을 업데이트해 주기 때문에, 이후에도 API 요청을 문제없이 계속 보낼 수 있습니다. 더 이상 반복적인 복사 및 붙여넣기 작업을 할 필요가 없습니다. 즉, DRY (Don’t Repeat Yourself) 원칙을 지킬 수 있습니다.

다음 단계

이번 튜토리얼에서는 Postman 스크립트를 사용해 환경 변수를 설정하고, 인증 토큰을 자동으로 저장 및 재사용하는 방법을 배웠습니다.

API 테스트에 대한 더 많은 예제와 assertion 작성 방법을 알고 싶다면, Postman에서 제공하는 Test API Functionality and Performance in Postman 가이드를 참고하면 도움이 됩니다.

목차