DevOps Day 9 (3.17) 웹서비스 개발 기초_HTTP 요청 실습 (Postman)

Postman 사용하는 방법

 

HTTP API 테스트 도구
웹 개발에서 사용하는 대표적인 클라인언트는 브라우저이며 웹 페이지를 받아오는 GET 요청에 사용합니다. 테스트를 위해 GET이 아닌 다른 요청을 보내려면, 개발자 도구의 콘솔 창에서 내장 함수 Fetch를 사용 해야 합니다.

HTTP API 테스트 도구 (CLI)
- Curl (대부분의 리눅스 환경에 내장되어 있음)
- wuzz : curl 명령어와 비슷하며 브라우저 네트워크 요청들을 수정/검토 할 수 있음

HTTP API 테스트 도구 (GUI)
- Postman : API 사용 및 생성 위한 API 애플리케이션
- Insomnia : Postman과 비슷한 애플리케이션

Postman 사용하기
HTTP로 소통하기 위해서는 API 서버의 endpoint가 URL로 주어져야 합니다.

Postman 화면 보기

1. 새로운 탭 오픈

o    요청/응답을 여러 개 확인할 수 있습니다.

1. HTTP 메서드 선택

o    GET, POST, DELETE 등과 같은 메서드 중 하나를 선택합니다.

o    API 문서 상 GET 메서드를 사용하므로, GET으로 선택합니다.

1. URL 입력 창

o    URL과 Endpoint를 입력합니다.

o    API 문서에 따르면, http://15.164.19.32:8000/api/cozmessages/kimcoding/messages 와 같이 입력하면 됩니다.

1. HTTP 요청 버튼

o    요청을 보냅니다.

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

o    추가적인 파라미터나, 요청 본문(body)을 추가할 수 있습니다.

o    API 문서에서 확인할 수 있듯이, roomname 이라는 파라미터를 사용할 수 있습니다. 필수는 아니지만, 파라미터를 사용하려면 Params 탭의 KEY, VALUE 에 각각 roomname 과 필요한 값을 입력합니다.

1. HTTP 응답 화면 - 요청을 보낸 후 응답을 확인하세요.

 

Post 요청하기
Post 요청은 GET 요청과 다르게 본문 (Body)를 포함하는 경우가 많습니다. 본문을 설정하는 방법은 위 내용 5. HTTP 요청 화면에서 본문을 입력하면 됩니다.

1. JSON 형식으로 보낼 때에는, raw를 선택합니다.
2. JSON을 선택 합니다.
3. API 문서에 따르면 username, text, roomname을 형식에 맞게 작성해야함

응답 살펴보기
- 일반적으로 서버가 요청에 대한 응답을 하지 않는 경우, 요청이 끝나지 않았습니다, 서버 문제로 timeout이라는 응답을 받게 됩니다.
- 결과에 아무것도 나오지 않거나, 기대했던 값이 나오지 아는 경우 HTTP 응답 코드를 확인!

 

Postman으로 API 테스팅하기
1. 가입 및 설치
2. 환경 설정 : My Workspace -> + 후 테스팅 시작
3. 테스팅 시작 : Postman을 활용하여 HTTP 요청을 합니다.

 

Endpoint
- root-endpoint (혹은 root-URL) : API로 요청을 서버와 통신할 때, 서버가 요청을 수락하는 시작점을 뜻합니다. 예: Github API의 root-endpoint는 https://api .github.com
- Path : path(또는 url-path)는 API를 통해 서버와 통신할 때, 서버와 통신할 수 있는 key 역할을 합니다

 

Open weather Map API : 국가별 날씨 (GET), 응답확인
1. Open Weather Map ID 생성
2. https://api.openweathermap.org/data/2.5/weather : Params 입력 (국가 날씨)
 - Key “q” + Value “Seoul”
 - Key “appid” + Value “open weather map appid”
3. https://api.openweathermap.org/data/2.5/weather?q=Seoul&appid={appid key}
4. JSON 응답 확인