✍️ 글쓰기/💻 배우고

Postman : 개념 및 API request

ddubimoon 2022. 1. 11. 03:57

https://www.postman.com/company/about-postman/

Postman 이란?

Postman은 API를 만들고 테스트하는 플랫폼이다. 공유된 RESTful API를 분석하고, 자신이 직접 만든 API를 테스트하는 데 주로 쓰인다. 일반적으로 API를 테스트하려면 HTML 리퀘스트를 보내야 하는데, 이때 HTML이나 자바 스크립트로 코드를 짜서 테스트 구현 환경을 만들어 주어야 한다. 하지만 Postman을 활용하면 그 과정을 생략하고, 플랫폼 상에서 즉각적으로 API의 기능들을 테스트해볼 수 있다.

 

Postman 설치

Postman 웹사이트에서 데스크탑 전용 어플리케이션을 받거나 로그인 후 브라우저에서 웹 앱 형태로 사용할 수 있다.

API Requests

원하는 API를 사용하기 위해 Postman에서 request를 보낼 수 있다. Request를 통해서 API를 불러오거나, 내용을 추가 혹은 업데이트하거나, 지울 수도 있다. (CRUD Operation

 

API request를 통해, 파라미터(parameter), 인증(authorization) 내용, 혹은 필요한 body 데이터들을 불러올 수 있다. 

쇼핑몰 웹 어플리케이션을 예로 들어보자. 판매 물품 리스트, 오더 리스트 등을 포함한 API에 request를 보내 필요한 내용들을 불러올 수 있다. 또 고객들이 로그인했을 때, 그 인증(authorization) 정보를 보내, 필요한 고객 정보를 불러올 수도 있다. 

 

API 요청(request)하기

1. 우선 작업을 진행할 공간, 즉 WorkSpace 를 만들어준다.

Workspaces > Create Workspace

 

Workspace 이름과 세부 내용, 권한여부 기재 > Create Workspace and Team

2. 새로운 HTTP Request를 만들어준다

New > HTTP Request

3. 원하는 API 주소를 기입하고, Request 방법을 정한다.

  • GET - 데이터 불러오기
  • POST - 새로운 데이터 추가
  • PUT - 기존의 데이터 교체
  • PATCH - 기존의 데이터 필드 업데이트
  • DELETE - 기존 데이터 삭제

그리고 Send 버튼 클릭.

4. GET method로 불러온 API 데이터

* 불러온 데이터를 보여주는 Body에서는 자동으로 불러온 데이터의 언어를 감지해 읽기 좋게 (pretty) 포맷팅(formatting) 해준다. 

아래의 예시에서는 불러온 데이터가 JSON 형식이라는 것을 감지, 읽기 편하도록 key-value 마다 엔터로 나누어진 모습이다.

Reference

https://www.postman.com/company/about-postman/

https://www.digitalcrafts.com/blog/student-blog-what-postman-and-why-use-it

https://learning.postman.com/docs