Postman 사용해보기

jungmin Lee·2023년 9월 12일

Postman

Postman은 사용자가 다양한 형태의 HTTP 요청을 만들고 테스트하며, API 엔드포인트와 상호작용하는 데 도움을 주는 플랫폼이다. API 테스트 도구는 클라이언트 입장에서 서버 API를 테스트하거나, API를 만드는 과정에서 매우 유용하다.

Postman 시작하기

가입 및 설치
Postman에 회원가입을 한 후, 프로그램을 설치한다.
환경 설정
Postman을 설치한 후, Workspaces에서 My Workspace를 클릭한 후 +를 눌러 테스팅을 시작한다. 기존에 사용한 적이 있다면 바로 테스트를 시작하면 된다.

테스팅 시작
Postman을 활용하여 HTTP 요청을 한다. YouTube API를 사용하여 검색어를 포함한 동영상을 검색하는 URL이며 Query Params을 통해 다양한 조건들을 설정하여 조회할 수 있다.

Postman 사용하기

GET 요청하기

URL
https://server.tiltile.co.kr/til/list
https://server.tiltile.co.kr/til/list?page=1&size=16
추가적인 파라미터를 사용할 수 있으며 URL로 입력도 가능하고 Query Params로 추가할 수도 있다.
list에서 1페이지의 16개 리스트에 대한 데이터를 요청했다.

Response
응답은 JSON 형식인 것을 확인할 수 있다.

{
    "cards": [
        {
            "tilId": 10,
            "tilTitle": "함수형 프로그래밍",
            "tilContent": "함수형 프로그래밍은 side Effect를 최소화하기 위해서 순수 함수를 사용하며 순수 함수는 input에 해당하는 output이 같고 변하지 않는 함수를 의미한다. 순수 함수는 동일한 입력에 대해서 항상 같은 결과를 반환....",
            "tilViewCount": 3,
            "createdAt": "2023-08-31T22:01:49",
            "modifiedAt": null,
            "memberNickname": "jungmin Lee",
            "memberId": 3,
            "memberProfileImage": "https://s3.ap-northeast-2.amazonaws.com/tiltile.co.kr/profile/2023/08/31/cca6616b-1985-4581-8399-5f33f856ffe7.jpg",
            "tilTier": null,
            "checkBookmark": false
        },
      // ...여러 개의 리스트  
    ],
    "pageNumber": 1,
    "totalPages": 1,
    "totalElements": 10,
    "size": 16,
    "startPage": 1,
    "endPage": 1
}

Postman 화면 보기

새로운 탭 오픈
요청/응답을 여러 개 확인할 수 있다.
HTTP 메서드 선택
GET, POST, DELETE 등과 같은 메서드 중 하나를 선택할 수 있다.
URL 입력 창
URL과 Endpoint를 입력한다.
HTTP 요청 버튼
HTTP 요청을 보낸다.
HTTP 요청 시 설정할 수 있는 각종 옵션
추가적인 파라미터나, 요청 본문(body)을 추가할 수 있다.

6.HTTP 응답 화면
요청을 보낸 후 응답을 확인할 수 있다.

POST 요청하기

POST 요청은 GET 요청과 다르게 본문(body)을 포함하는 경우가 많다.
POST 요청할 때, body를 아래의 순서대로 클릭한 후 JSON 형식으로 작성한 후 보낸다. 성공적으로 요청이 완료되면 응답을 JSON 형식으로 확인할 수 있다.

URL
https://server.tiltile.co.kr/til

JSON 형식으로 보낼 때에는, raw를 선택한다.
보낼 형식에 맞게 정확한 타입을 선택한다. JSON 형식으로 보낼 때에는, JSON을 선택한다.
=> 1번 및 2번 과정은 HTTP 요청 헤더에 아래와 같이 입력한 것과 동일하다

Content-Type: application/json

본문 내용을 선택한 형식에 맞게 입력한다.

Postman with Open API

Open Weather Map의 API Docs를 보고 Open API를 사용하여 원하는 지역의 날씨를 요청하고, 응답을 확인할 수 있다.

https://openweathermap.org에 접속한다.
회원가입 후 로그인을 한다.
회원가입 후 메일 주소로 인증 메일을 받고, 인증 절차를 진행한다.
로그인 후에 API Keys 탭을 누르면 기본 Default API 키가 발급된 것을 확인할 수 있다.
추가로 키를 발급하기를 원할 경우에는 Create key에 새로 발급할 API Key 이름을 추가해 Generate를 누르면 추가로 발급이 가능하다.
원하는 API 탐색
상단에 있는 내비게이션 바의 API를 클릭하면, 사용할 수 있는 API 리스트를 확인할 수 있다.
Current Weather Data 카드에 있는 API Doc을 눌러 문서를 확인할 수 있다.
'By city ID'라는 소제목의 글을 보면, URI를 확인할 수 있다.
주어진 URI와 발급받은 API 키로 날씨 데이터에 접근할 수 있으며, 중괄호 안에 있는 city id에는 OpenWeather에서 도시마다 부여한 ID 중 하나를 입력할 수 있다. 서울의 날씨를 알고 싶은 경우에는 서울의 city id인 1835848을 적어주면 된다. your api key에는 발급받은 API Key를 입력한다.
api.openweathermap.org/data/2.5/weather?id={city id}&appid={your api key}
API 호출은 URI나 Postman으로 확인할 수 있다.