[프로젝트] 포스트맨(Postman)으로 REST API 설계하기

API를 통해 데이터를 받아오는 코드를 작성하기 전에, API에서 나의 요청대로 제대로 된 데이터를 받아오는지 먼저 확인을 해볼 필요가 있다. 오늘은 이 과정에 아주 유용한 Postman이라는 플랫폼에 대해 알아본다.

 

용어와 개념

포스트맨이란?

Postman (www.postman.com)

Postman API Platform | Sign Up for Free

포스트맨(Postman)은 편리한 REST API 설계, 개발, 테스팅 기능을 툴(Tool)로 제공하고, 그 결과를 공유하여 개발 생산성을 높여주는 플랫폼이다. API 테스트뿐만 아니라 Collection Sync, API Monitoring 등 팀원들이 협업하는데 도움을 주는 기능을 제공하기 때문에 툴이 아닌 플랫폼이다.

* Postman은 개인 사용 목적인 경우는 무료, 팀 라이브러리 관련 Collection Sync, API 모니터링 기능들은 유료 서비스​

RESP API를 사용하는 클라이언트를 개발하는 경우 서버와의 API 인증과 동작을 먼저 확인 후 파이썬(Python), 자바(Java), NodeJS, PHP 등의 언어로 소스 코드를 작성하는 경우가 많다. 이러한 목적으로 전통적인 curl을 사용하여 다양한 옵션으로 API를 테스트할 수 있지만, 커멘드 라인(Command Line) 기반의 툴이기 때문에 많은 '타이핑'이 필요하다는 것이 단점이다. 그렇지만 Postman을 이용하면 편하게 API를 테스트할 수 있기 때문에 많이 사용된다.

 

CURL

Client URL

클라이언트에서 커맨드 라인이나 소스코드로 손 쉽게 웹 브라우저 처럼 활동할 수 있도록 해주는 기술(커맨드라인 Tool 혹은 라이브러리)이다. 서버와 통신할 수 있는 커맨드 명령어 툴로, 웹개발에 매우 많이 사용되고 있는 무료 오픈소스이다.

특징

• 수 많은 프로토콜을 지원한다는 장점이 있다. (DICT, FILE, FTP, FTPS, Gopher, HTTP, HTTPS, IMAP, IMAPS, LDAP, LDAPS, POP3, POP3S, RTMP, RTSP, SCP, SFTP, SMB, SMBS, SMTP, SMTPS, Telnet, TFTP)
• SSL 인증 방식이 가능하다.

사용법

• curl [-option] https://minjin-sw.tistory.com 하게되면 소스가 화면으로 출력된다.
• 이외에 옵션을 이용하여 사용할 수 있다.

-k	--insecure	https 사이트를 SSL certificate 검증없이 연결한다.	wget 의 --no-check-certificate 과 비슷한 역할 수행
-l	--head	HTTP header 만 보여주고 content 는 표시하지 않는다
-D	--dump-header <file>	<file> 에 HTTP header 를 기록한다.
-L	--location	서버에서 HTTP 301 이나 HTTP 302 응답이 왔을 경우 redirection URL 로 따라간다. --max-redirs 뒤에 숫자로 redirection 을 몇 번 따라갈지 지정할 수 있다. 기본 값은 50이다	curl -v daum.net 을 실행하면 결과값으로 다음과 같이 HTTP 302 가 리턴된다. < HTTP/1.1 302 Object Moved < Location: http://www.daum.net/ -L 옵션을 추가하면 www.daum.net 으로 재접속하여 결과를 받아오게 된다.
-d	--data	HTTP Post data	FORM 을 POST 하는 HTTP나 JSON 으로 데이타를 주고받는 REST 기반의 웹서비스 디버깅시 유용한 옵션이다
-v	--verbose	동작하면서 자세한 옵션을 출력한다.
-J	--remote-header-name	어떤 웹서비스는 파일 다운로드시 Content-Disposition Header 를 파싱해야 정확한 파일이름을 알 수 있을 경우가 있다. -J 옵션을 주면 헤더에 있는 파일 이름으로 저장한다.	curl 7.20 이상부터 추가된 옵션
-o	--output FILE	curl 은 remote 에서 받아온 데이타를 기본적으로는 콘솔에 출력한다. -o 옵션 뒤에 FILE 을 적어주면 해당 FILE 로 저장한다. (download 시 유용)
-O	--remote-name	file 저장시 remote 의 file 이름으로 저장한다. -o 옵션보다 편리하다.
-s	--silent	정숙 모드. 진행 내역이나 메시지등을 출력하지 않는다. -o 옵션으로 remote data 도 /dev/null 로 보내면 결과물도 출력되지 않는다	HTTP response code 만 가져오거나 할 경우 유리

 

 

포스트맨 사용하기

위에 설명했듯이 포스트맨을 활용하여 REST API를 설계, 개발, 테스팅해볼 수 있다.

API 설계하기

왼쪽 탭에서는 Collections, APIs 등 다양

한 탭이 있는데, 우선 Collections에서 폴더와 같은 개념의 collection을 생성/관리할 수 있다.

API 탭에서 API의 버전을 설정하고 관리할 수 있다. 왼쪽 + 버튼을 클릭하면 다음과 같은 창에서 API 정보를 입력할 수 있다.

 

본격적으로 API를 만들어보자. My Workspace 옆의 New 버튼을 누르면 다음과 같은 창이 뜨며, 여기서 API를 설계해볼 수 있다.

가장 기본적으로 많이 쓰이는 프로토콜인 HTTP Request를 누르면 손쉽게 API를 만들 수 있다.

이러한 창에서 GET / POST 등의 메소드를 선택할 수 있고, API이름, URL 입력 등을 해볼 수 있다.

 

API 테스트하기

위와 같이 만든 API에서 URL을 입력하고 Send버튼을 눌러 이 Request를 전송하면, 다음과 같이 Body를 확인할 수 있다.

 

참고로 이 결과값을 어떤 형식으로 할 것인지도 결정할 수 있다.

 

테스트 스크립트 작성하기

request의 test 탭에서 테스트 스크립트를 작성할 수 있다. 코드는 JavaScript로 작성을 하면 되며, 테스트 결과는 하단의 Test Results에서 확인할 수 있다.

스크립트 예제

tests["responseBody = " + responseBody] = true;

pm.test("Status code is 200", function(){
    pm.response.to.have.statusCode("200")
    pm.response.to.have.jsonBody("headers.host")
});

테스트를 작성하는 방법은 2가지가 있는데 tests["test name"]= (true/false logic) 또는  pm.test를 사용하여, 테스트의 제목과 validation 체크 로직 작성을 할 수 있다.

하나의 유효성 체크만 하려면 tests를, 여러 값을 체크를 하기 위해서는 pm.test 를 사용하면 된다.

 

---

참고 사이트

• 폐관코딩님 블로그 (https://shutcoding.tistory.com/23)
• https://blog.naver.com/PostView.naver?blogId=dktmrorl&logNo=222392840317&parentCategoryNo=&categoryNo=19&viewDate=&isShowPopularPosts=false&from=postView
• https://nhj12311.tistory.com/393
• https://goateedev.tistory.com/63