Postman 을 이용한 REST API 개발 & 테스트

이제는 HTTP 를 기반으로하는 REST API 개발은 아주 일상적인 일이 되었다.

웹 기반의 RESR API 를 손쉽게 개발 & 테스트하는 도구로는 Postman 소프트웨어가 있다. (대부분의 모바일 개발자들은 다 알고 있을 것 같다)

Postman 은 www.getpostman.com 또는 크롬 웹 스토어 에서 설치할 수 있다.


먼저 스프링을 기반으로 개발된 다음과 같은 API 가 있다고 하자.

1. 게시판 목록 조회 API
/boards/list.json

2. 게시판의 게시물 목록 조회 API
/boards/{boardId:[\\p{Digit}]+}/threads/list.json

Postman 을 실행하고 호출 방법(1) , URL (2) 입력하고 Send(3) 버튼을 클릭하면 결과(4) 를 확인 할 수 있다. AJAX 기반의 웹 프로그램을 개발하거나 모바일 API 를 개발하는 경우라면 아주 쉽게 개발된 API 를 테스트할 수 있다.

그림1. Postman 실행화면

인증이 필요한 API 이고 Spring Security 를 사용하고 있다면 간단한 설정 추가를 통하여 Basic Authentication 기능을 추가할 수 있고 Postman 에서는 요청을 만들때 Authorization 정보를 입력(1)하여 손쉽게 인증이 요구되는 API 들에 대한 테스트가 가능하다.

그림2. Basic Auth 를 통한 요청

기본적으로 한번 Basic Authentication 이 처리되면 이후 요청부터는 세션이 생성되어 인증된 상태에서 요청이 전달된다.

앱을 개발하거나 또는 AJAX 기반의 웹 API 개발시에는 UI 개발이후에 테스트하고 디버깅을 진행하였으나 Postman 을 사용하여 API 개발과 통시에 테스트를 진행할 수 있어 개발 생산성을 향상시킬수 있었다.