Postman

Postman은

RestAPI(GET, POST, PUT,...)의 호출을 쉽게 하고, 응답값을 보기 좋게 확인할 수 있으며,

이를 문서화하여 체계적으로 관리, 공유할 수 있게 해주는 플랫폼입니다.

팀 기능을 사용하면, 이를 통해 협업을 할 수가 있는데 이는 유료 기능인 듯합니다.

API 결과값으로 시각화를 할 수 있는 기능도 있습니다.

https://www.postman.com/

Postman API Platform | Sign Up for Free

(웹사이트에서 이용할 수도 있고, 앱도 제공을 하는데. 앱은 Electron으로 작성되어 웹사이트와 크게 차이가 없어 보입니다)

 

앱 개발자로서 이 플랫폼은

앱 개발을 하면서 RestAPI를 호출하는 코드를 구현하기 전에,

응답값을 미리 확인해 봄으로써, 그에 따른 Decodable 구조체를 작성하기 매우 편리하게 도와줍니다.

Code Snippet기능으로 Swift의 URLSession으로 Request를 작성하는 코드를 만들어주기도 합니다.

 

간단한 예제로. 오늘은 PunkAPI를 호출해보겠습니다.

(https://punkapi.com/documentation/v2

PunkAPI는 RestAPI를 통해 맥주에 대한 정보를 내려주는 API입니다)

PunkAPI 문서를 보면

파라미터 값들을 통해 다양한 조건의 맥주들의 결과값을 받을 수 있고,

여러 페이지로 나누어 결과를 받을 수 있는 페이징 기능도 있으며,

랜덤으로 결과를 받을 수도 있습니다.

 

Postman으로 돌아가서,

Collection에 PunkAPI를 만들고 API를 작성해봅니다.

(1) 에서는 Collection을 만들어 관련 API끼리 모아 관리할 수 있고

(2) 에서는 RestAPI Method를 선택하거나, 텍스트로 직접 API를 작성할 수 있습니다.

(3) 에서는 Parameters, Header, Body 등을 설정할 수 있습니다. (2)에서 작성한 파라메터는 (3)의 파라메터에, 혹은 (3)에 작성한 파라메터는 (2)에서 자동으로 반영됩니다. 커스텀 User-Agent 설정이 필요하다면 여기서 작성해줄 수 있습니다.

(4) 에서는 위에서 작성하고 상단에 [Send] 버튼을 눌러서 받은 응답값을 다양한 형태로 확인해 볼 수 있습니다.

(5) 에서 </> 버튼을 누르면, 아래와 같이 원하는 언어의 Code Snippet을 확인하고 복사할 수 있습니다.