본문 바로가기
Tool

[Postman] API 개발, 공유, 테스트, 저장소 플랫폼

by 집탱구리 2022. 8. 4.
반응형

일을 하다보면 종종 외부 API를 사용해야 할 때가 있다.

물론 내부 API개발을 해야될 때도 있고.

그럴 때 유용하게 쓸 수 있는 플랫폼이 postman이다.

 

기능이 워낙 많아 전부 활용 하고 있지는 못하지만

API개발과 테스트 그리고 협업 할 때 유용하게 쓰이고 있다.

 

공식 사이트 : https://www.postman.com/

 

Postman API Platform | Sign Up for Free

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.

www.postman.com

 

공식 사이트에서는 Postman을 이렇게 설명 하고 있다.

API 저장소
하나의 중앙 플랫폼에서 모든 API 아티팩트를 쉽게 저장, 카탈로그화 및 협업할 수 있습니다.
Postman은 API 사양, 문서, 워크플로우 레시피, 테스트 사례 및 결과, 메트릭 및 기타 API와 관련된 모든 것을 저장하고 관리할 수 있습니다.

 

PC에 다운로드 해서 사용 할 수 있다.

다운로드 링크 → https://www.postman.com/downloads

구글로 계정을 생성해서 사용할 수 있다.

계정 생성이 완료되면 브라우저에서도 pc앱과 같은 화면으로 사용이 가능하다.

나는 앱을 설치하여 pc에서 쓰고 있다.

아래는 앱 화면이다.

로그인을 하면 아래처럼 My Workspace가 나오면서 내 활동 기록들이 나오게 된다.

현재 개인 작업공간으로 생성되어 내가 생성한 API 또는 문서 등을 나만 볼 수 있게 되어있다.

팀원들과 공유 할 수 있는 workspace도 생성 가능하다.

 

좌측 New 버튼을 눌러보면 여러가지를 생성 할 수 있는 팝업창이 뜬다.

여기서 새로운 Request, Collection, API Document 생성을 할 수 있다.

 

+버튼으로 새로운 탭을 열거나 팝업창에서 HTTP Request를 눌러 새 탭을 연다.

HTTP매서드를 선택한뒤 테스트 할 API URL을 입력한다.

 

내가 테스트 할 API는 공공데이터포털에서 신청한 오픈API  "예방접종센터 위치정보 API"이다.

메서드는 GET으로 선택 한 후 URL을 삽입한다.

그리고 Query Params에 KEY, VALUE 값을 입력한다.

 

공공데이터포털 오픈API를 사용하기 위해서는 제공된 API키를 입력해야된다.

Params탭 옆에 Authorization탭으로 이동해본다.

여기서는 해더에 들어갈 권한을 입력 할 수 있다.

공공데이터 오픈 API를 사용 할 땐 타입을 API Key로 선택하고 부여받은 인증키를 삽입한다.

Send버튼을 클릭해주면 아래에 Response영역에 API호출값이 나온다.

이 오픈API의 return  type은 기본적으로  json으로 설정되어있다.

XML값으로 받고 싶으면 파라미터에  returnType을 XML로 변경하면 된다.         

 

요청 결과값은 3가지 타입으로 확인 할 수 있다.

Pretty, Raw, Preview                     

 

그리고 이 API내용을 저장 하려면 상단에 Save 버튼을 클릭한다.

 

아래와 같은 팝업창이 뜬다.

Request name에 이름을 넣고(Add description에 설명을 입력해도된다.)

collection이 없다면 새로 생성하여 저장한다.

 

save를 클릭하면 workspace화면으로 돌아온다.

아래처럼 collection에 추가된 화면이 보인다.

 

또 좌측 맨아래에 History탭에 가보면 오늘 내가 실행했던 API들을 볼 수 있다.

 

 

이정도로만 알면 기본적인 API테스트는 가능하다.

더 자세한 내용은 postmen docs로 가서 찾아보는게 좋을것 같다.

https://learning.postman.com/docs/getting-started/introduction/

 

Introduction | Postman Learning Center

Introduction: documentation for Postman, the collaboration platform for API development. Create better APIs—faster.

learning.postman.com

 

반응형

댓글