포스트맨(API 테스트) 활용하기

📎  글또 6기 포스팅

1. 미치도록 더웠던 7월의 회고

 

2. 사용자가 게시물을 작성할 때의 트랜잭션 처리

 

3. Spring AOP - (1) 프록시 패턴, 데코레이터 패턴

 

4. [MySQL] - 트랜잭션의 격리 수준(Isolation level)

 

5. Spring AOP - (2) AOP 개념 및 실습

 

6. 인텔리제이(IntelliJ) - 디버깅(Debugging) 하기

 

7. [Java, 디자인패턴] - 싱글턴 패턴(Singleton Pattern)

 

8. 월간 코드리뷰 Ver_0.1: 커리어 성장 CODE 세미나 정리

 

9. 포스트맨(API 테스트) 활용하기

 

10. 뜻깊은 2021년 회고

---

 

📎 포스트맨 활용하기

안녕하세요, 이번 시간에는 포스트맨에서 제공하는 여러 기능들에 대해 살펴보겠습니다.

저는 그동안 포스트맨을 API를 테스트하는 용도로만 사용했었습니다. 하지만 이 외에도 API 정보를 공유하거나 변수를 설정하고, 환경별로 분리하는 등 다양한 기능들을 포함하고 있는데요, 이를 활용하면 좀 더 다방면으로 포스트맨을 사용할 수 있습니다.

 

포스트맨에 대해 먼저 말씀드리자면, 공식 문서에는 아래와 같이 설명하고 있습니다.

Postman is an API platform for building and using APIs. Postman simplifies each step of the API lifecycle and streamlines collaboration so you can create better APIs—faster.

https://www.postman.com/

요약해보자면, API를 테스트할 수 있는 소프트웨어라고 생각하시면 될 것 같습니다.

 

 

포스트맨을 설치하고 사용하는 방법에 대해서는 아래 포스팅을 참고해주세요 ~

https://binit.tistory.com/17

포스트맨(Postman) 사용법과 API 실행해 보기

이번 포스팅에서는 포스트맨에서 API 정보를 공유하고, 변수 및 환경별로 설정하는 방법에 대해 살펴보겠습니다.

 

 

 

📎  배경

---

이번 포스팅을 작성하게 된 계기는 다음과 같습니다.

 

평소에 개발을 진행하면서 로컬에서만 개발하고, 테스트를 하면 상관없지만 개발 환경과 로컬 환경, 상용 환경 등 다양한 환경에서 테스트를 하기 위해서는 각 환경에 따라 API를 만들고, 테스트를 진행해야 합니다.

이러면 테스트를 할 때 마다 URI와 Request, 기타 정보(토큰 등) 등을 별도로 만들어 주어야 합니다. 아래와 같이 말이죠..

위와 같을때 한 개의 API를 테스트하기 위해선 각 환경별로 총 3개의 API를 만들어서 테스트를 진행해야 합니다.

API가 얼마 되지않는다면 번거롭긴 해도 문제되지는 않겠으나.. 수십 수백개가 된다면? API 갯수 * 3 만큼 반복적인 노가다를 해야합니다.

따라서 포스트맨의 변수를 사용해 위와 같은 문제를 해결할 수 있습니다.

 

 

 

📎  방법

그럼 이제 포스트맨에서 위와같은 불상사를 막기위해 환경 별 변수를 생성해보도록 하겠습니다.

 

포스트맨을 실행한 후 아래 사진처럼 눈(?) 버튼을 클릭한 후 Add 를 클릭합니다.

 

 

그 후 환경 이름(Dev, Prod)과 변수(X-Code, X-Token) 등을 작성하고 저장합니다.

 

 

 

Request를 생성하고 위에서 설정한 환경 및 변수 값을 설정합니다.

(1) 부분에서 먼저 필요한 환경(Dev / Local / Prod)을 선택하고, 설정한 변수값을 아래와 같이 {{ }} 안에 작성하면 됩니다.

 

 

설정한 환경에 따라 변수 값이 다르게 나타나는 것을 확인할 수 있습니다.

 

 

 

Host

호스트 또한 설정하여 사용할 수 있습니다. 

보통 로컬에서 테스트를 할 때는 localhost를, AWS와 같은 클라우드는 특정 IP가 지정이 되는데요, 이때도 변수를 설정해서 활용할 수 있습니다.

위 사진은 로컬 환경서 테스트를 할 때 설정한 localhost 입니다.

 

위 사진은 상용(운영) 환경에서 설정한 Host입니다.

 

실제 테스트를 할 때는 위에서 설정한 변수명을 지정하면 됩니다.

이후 개발 환경에서는 Dev를, 상용 환경에서는 Prod를 지정해서 테스트를 할 수 있습니다.

 

 

 

📎  추가

추가적으로 포스트맨에서 설정한 정보들을 Export해서 다른 사용자와 공유할 수 있습니다.

Collections 우클릭 > Export 를 클릭합니다.

 

 

그 후 원하는 버전을 클릭하고 Export를 클릭하면 파일로 받을 수 있습니다.

 

 

위 파일을 불러올때는 포스트맨에서 Import를 한 뒤 Export한 파일을 불러오면 됩니다.

 

 

📎  정리

이상으로 포스트맨을 활용하는 방법에 대해 살펴보았습니다.

저는 API를 테스트 할 때는 거의 항상 포스트맨을 사용하는데요, 이번 기회에 좀 더 포스트맨을 활용할 수 있었습니다.

위의 기능들 외에도 포스트맨에 다른 인원을 초대해 공동으로 사용한다던가, 글로벌 변수를 설정한다던가 등등의 추가 기능들이 있습니다.

다음에는 추가적으로 유용한 기능들과 함께 포스팅하도록 해보겠습니다.