[9일차] 포스트맨을 통한 실습

https://ko.wikipedia.org/wiki/%ED%8C%8C%EC%9D%BC:Postman_%28software%29.png

 

POSTMAN

API 개발을 위한 협업 플랫폼으로. Postman의 기능은 API 구축의 각 단계를 단순화하고 협업을 간소화하므로 더 나은 API를 더 빠르게 만들 수 있다.

 

 

postman 사용하기

1. 새로운 탭 오픈
   •  요청/응답을 여러 개 확인할 수 있다.
2. HTTP 메서드 선택
   • GET, POST, DELETE 등과 같은 메서드 중 GET으로 선택한다.
3. URL 입력 창
   •  URL과 Endpoint를 입력합니다.
   •  API 문서에 따르면, http://3.36.125.54:8000/api/cozmessages/kimcoding/messages 와 같이 입력하면 된다.
4. HTTP 요청 버튼
5. HTTP 요청시 설정할 수 있는 각종 옵션
   • 추가적인 파라미터나, 요청 본문(body)을 추가할 수 있다.
   • API 문서에서 확인할 수 있듯이, roomname 이라는 파라미터를 사용할 수 있다.
   • 필수는 아니지만, 파라미터를 사용하려면 Params 탭의 KEY, VALUE 에 각각 roomname 과 필요한 값을 입력한다.
6. HTTP 응답 화면 - 요청을 보낸 후 응답을 확인

 

root-endpoint(혹은 root-URL)

• API로 요청을 서버와 통신할 때, 서버가 요청을 수락하는 시작점을 말한다

 

path(또는 url-path)

• API를 통해 서버와 통신할 때, 서버와 통신할 수 있는 key 역할을 한다.
• 서버에 정의된 문자열에 따라 path가 달라진다.
• ex) https://api.github.com/user 에서는 'user'가 path이다.

 

 

메세지 조회

• URL: http://3.36.125.54:8000
• 메시지 요청: POST/api/cozmessages/<이름>/messages

• 1.응답은 post로 설정한다
• 2-3. 본문 형태가 JSON형태일 경우 raw를 사용
• 4.본몬 내용: 앞서 JSON을 선택했으므로, 유효한 JSON을 적어야 한다.
• 5. response를 전송하면 6번 id가 나온다

 

response

• 메시지 응답: GET/api/cozmessages
• get을 통해 id: 227번의 내용이 전달된걸 확인

 

메세지 삭제

DELETE /api/cozmessages/<이름>/clear