2022-01-28 API test tools / Postman 사용하는 방법

HTTP API 테스트 도구

 

웹 개발에서 사용하는 대표적인 클라이언트는 브라우저임.

 

브라우저는 서버에 HTTP 요청을 보낼 수 있는 훌륭한 도구이지만,

 

주로 웹 페이지를 받아오는 GET 요청에 사용함.

 

브라우저의 주소창에 URL을 입력하면, 해당 URL의 root-endpoint로 GET요청을 보냄.

 

테스트를 위해 GET이 아닌 다른 요청을 보내려면, 개발자 도구의 콘솔 창에서 내장함수 fetch를 사용해야함.

 

매번 fetch 어쩌구 저쩌구 할 수 있지만 귀찮지..

 

그래서 HTTP 요청을 테스트할 수 있는 다양한 고구가 있음!

 

많은 API가 HTTP 프로토콜을 이용하므로 API 테스트 도구라고 부름!

 

HTTP API 테스트 도구 (CLI)

• curl (대부분의 리눅스 환경에 내장)
• wuzz

HTTP API 테스트 도구 (GUI)

• Postman
• Insomnia

 

 

Postman 사용하기

 

이미 만들어져 있는 API 서버가 주어지는 경우를 먼저 고려해 보자.

 

HTTP로 소통하기 위해서는 API 서버의 endpoint가 URL로 주어져야 함.

 

 

 

 

 

GET 요청하기

예를 들어 다름과 같은 API 문서가 있다고 생각해보자

---

URL

http://3.36.72.17:3000/

메시지 조회

Request

GET /kimcoding/messages

[요청] kimcoding이 작성한 모든 메시지를 조회합니다.

 

추가적인 파라미터를 사용할 수 있습니다.

parameter	형식	설명	필수 포함 여부
roomname	방 이름(문자열)	특정 roomname만 조회	필수 아님

[표] 파라미터 정보

 

Response

응답은 다음과 같은 JSON 형식입니다.

[
  {
    "id": 1,
    "username": "김코딩",
    "text": "안녕하세요",
    "roomname": "로비",
    "date": "2021-04-02 12:00:00"
  }
 // ...여러 개의 메시지
]

[데이터] Request에 따른 Response 예시

메시지에서 사용하는 속성은 다음과 같습니다.

 

parameter	형식	설명
id	숫자	고유한 아이디
username	문자열	사용자 이름
text	문자열	본문 내용
roomname	문자열	방 이름
date	문자열	작성한 시간

[표] 파라미터 정보

---

Postman 화면 보기

 

다름 그림을 보고 포스트맨의 화면 구성을 확인합니다.

 

1. 새로운 탭 오픈

- 요청/응답을 여러 개 확인할 수 있음

 

2. HTTP 메서드 선택

- GET POST DELETE 등과 같은 메서드를 선택함

 

3. URL 입력 창

URL과 Ednpoint를 입력합니다.

예를 들어, http://3.36.72.17:3000/id/message

 

4. HTTP 요청 버튼

- 요청을 보냅니다

 

5. HTTP 요청시 설정할 수 있는 각종 옵션

- 추가적인 파라미터나 요청, 본문을 추가할 수 있습니다

 

6. HTTP 응답 화면

- 요청을 보내고 응답을 확인할 수 있음

 

 

 

POST 요청하기

 

GET 요쳥은 브라우저로도 충분히 테스트할 수 있지만

 

POST 요청은 GET 요청과 다르게 본문을 포함하는 경우가 많음.

 

본문을 설정하려면 5번 HTTP 요청 설정 화면에서 본문을 입력하면 됨

 

 

---

URL

http://3.36.72.17:3000/

메시지 추가

Request

POST /kimcoding/messages

[요청] kimcoding이 새로운 message를 작성합니다.

요청 본문에는 다음의 내용을 반드시 포함해야 합니다.

• 요청 형식: JSON

parameter형식설명필수 포함 여부

username	문자열	사용자 이름	필수
text	문자열	본문 내용	필수
roomname	문자열	방 이름	필수

[표] 파라미터 정보

 

Response

응답은 다음과 같은 JSON 형식입니다.

{
  "id": 5
}

[데이터] Request에 따른 Response 예시

id는 숫자 형식이며, 새로 생성된 메시지의 고유한 ID 값입니다.

 

---

다음 그림을 참고해 POST 요청에 본문을 함께 보내자

 

[ 그림 ] POSTMAN에서 새로운 메시지를 본문에 담아 POST 요청을 보내는 화면

1. 본문의 형식 선택 (1)

- JSON 형식으로 보낼 때에는, raw 선택

 

2. 본문의 형식 선택 (2)

 

-  JSON 형식으로 보낼 때에는, JSON을 선택

- 앞서 1번 및 2번 과정은 HTTP 요청 헤더에 다음과 같이 작성하는 것과 동일함

Content-Type: application/json

 

 

3. 본문내용

 

- 본문을 입력함. 앞서 JSON을 선택했으므로, 유효한 JSON을 적어주어야 함.

 

username, text, roomname을 형식에 맞게!

 

4. 요청 보냄!

 

HTTP 응답 코드를 확인하면서 문제를 해결해보자!