포스트맨(Postman)을 활용한 REST API 테스트하기

안녕하세요 오랜만에 왔습니다.

이번 글에서는 포스트맨을 사용해 REST API를 테스트하는 기본 방법을 알아보겠습니다.

REST API는 웹 서비스 간 소통을 위한 인터페이스로, 안정적이고 효율적인 개발을 위해서는 API 테스트가 필수적입니다. 포스트맨(Postman)은 API 테스트를 쉽고 빠르게 할 수 있도록 지원하는 강력한 도구입니다. 

 

우선, 포스트맨 설치 및 기본 환경 설정에 대해서 해 보겠습니다.

포스트맨 공식 웹사이트에서 프로그램을 다운로드 하여 설치 하시면 됩니다. 저는 구글 계정 연동으로 만들었습니다 !

 

하단 공식 링크 참고

https://www.postman.com/downloads/

 

설치를 하게 되면 하단의 사진처럼 나오실텐데요, 전 이것저것 많이 해 둬서 ... 가득가득하답니다.

폴더 이름을 꾸미실 수 있고, 안에 예쁘게 정렬 하실 수 있어요.

 

이제 REST API 요청을 보내 보실 건데요, 

 

 

 

상단의 [New] 버튼을 클릭하고,

 

 

HTTP Request를 선택합니다.

 

포스트맨으로 REST API를 테스트하는 첫 단계는 요청(Request)을 보내는 것입니다.

• 포스트맨을 열고 왼쪽 상단에서 'New' 버튼을 클릭한 후 'HTTP Request'를 선택합니다.
• 메서드(GET, POST, PUT, DELETE 등)를 선택하고, URL 입력란에 테스트할 API의 주소를 입력합니다.
• 필요한 경우 'Headers' 탭에서 인증 정보나 추가 헤더를 설정합니다.
• 'Body' 탭에서 JSON, form-data 등 원하는 형태의 요청 데이터를 입력합니다.

 

 

이제 선택 후에, 요청을 보내야 하는데요.

예를 들어, 사용자 정보를 조회하는 GET 요청을 보낼 때는 아래와 같이 설정할 수 있습니다:

Method: GET
URL: https://api.example.com/users/123

요청을 설정한 후 'Send' 버튼을 클릭하면 서버로부터 응답(Response)을 받을 수 있습니다.

 

응답(Response) 확인 및 분석

응답 결과는 하단 패널에서 확인할 수 있으며, 상태 코드(Status code), 응답 시간(Response time), 응답 크기(Size)를 확인할 수 있습니다.

• 상태 코드 200: 성공
• 상태 코드 400번대: 클라이언트 오류
• 상태 코드 500번대: 서버 오류

응답 데이터는 JSON 또는 XML 형태로 반환될 수 있으며, 포스트맨은 자동으로 응답 데이터를 읽기 쉽게 포맷팅하여 표시해줍니다.

4. 환경변수(Environment Variables) 활용하기

포스트맨은 환경변수를 사용하여 반복되는 값(예: API 키, 인증 토큰)을 편리하게 관리할 수 있습니다.

• 우측 상단의 환경 설정 메뉴에서 'New Environment'를 생성합니다.
• 환경변수를 설정한 뒤 요청 URL이나 헤더 값에 {{변수명}} 형식으로 참조할 수 있습니다.

예시:

URL: https://api.example.com/users/{{userId}}

 

포스트맨을 이용하면 REST API를 쉽고 빠르게 테스트하고 관리할 수 있으며, 효율적인 개발 프로세스를 구축할 수 있습니다. 본 글에서 소개한 내용을 바탕으로 포스트맨을 활용한 REST API 테스트를 직접 수행해 보시길 권장합니다.