[💻 코드스테이츠 FE 44기] Postman, Message State, 종합퀴즈

✔️ 시작

Postman을 이용해 API를 테스트 할 수 있었다.
이번 종합퀴즈 몇몇 문제가 이해가 되지 않아서 같이 블로깅하려고 한다.

---

📍배운 것

✔️ HTTP API 테스트 도구

CLI

• curl (대부분의 리눅스 환경에 내장되어 있다.)
• wuzz

GUI

• Postman
• Insomnia

사용하기 쉬운 Postman으로 API 테스트를 했다.
[postman 바로가기]

무료 날씨 API (openweathermap)

• [openweathermap 바로가기]
• 로그인 또는 회원가입 후 (메일 인증 진행해야함)
• API Key를 받을 수 있다.
  
• Current Weather Data [API doc]에서 여러 가지 방법으로 날씨 정보를 가져올 수 있다.
• 이때 API Key 정보가 있어야 날씨를 불러올 수 있다.

✔️ Message State

endpoint

• 같은 여러 URL에 대해 다른 요청을 할 수 있게 구별해 주는 항목
• API가 서버에서 자원(Resource)에 접근할 수 있도록하는 URL

root-endpoint(또는 root-URL)

• API로 요청을 서버와 통신할 때, 서버가 요청을 수랑하는 시작점
• 일반적으로 root-endpoint는 도메인 주소의 루트(/)를 가리킨다.
• Message State Server의 URL을 기준으로 파악할 수 있는 root-endpoint :
  Message State Server의 가장 마지막 Location인 호스트의 루트(/)이다.

Github API의 root-endpoint : https://api.github.com
트위터 API의 root-endpoint : https://api.twitter.com

path(또는 url-path)

• API를 통해 서버와 통신할 때, 서버와 통신할 수 있는 key역할
• 서버에 정의된 문자열에 따라 path가 달라진다.

https://api.github.com/user 에서 'user'가 path이다.

✔️ 종합퀴즈

• 문제 풀면서 답하고 매치가 잘 안되고 이해하기 어려운 부분이 있었다.

endpoint

• endpoint를 작성할 때 동사(= 동작을 묘사)말고 명사(= 이름품사)로 작성해 줘야한다.
• endpoint를 작성할 때 복수 형태로 사용하는 거 같다. (resturants, seats 등)
• 앞에 메서드(POST, DELETE 등)을 사용했을 때 endpoint에 한 번 더 (post, delete 등) 작성할 필요가 없다. (ex - DELETE/delete)

Path Parameter

• 전체 데이터 또는 특정 하나의 데이터를 다룰 때 사용

Query Parameter

• filtering, ordering, searching에 많이 사용한다.
• offset: 리소스 컬랙션의 첨음 N개 항목을 응답에서 제외하는 데 사용
• limit: 단일 응답 페이지에 포함된 리소스 수를 지정

기타

• POST 요청에 의해 정보가 생성 되는 것은 HTTP 응답코드 201 Created가 적합하다. (200 OK 보단)
• HTTP 응답 메시지는 영문/한글 여부는 상관 없다.

---

✏️ 마치며

실습 관련 과제는 이해할 수 있겠지만.
이론 관련된 과제의 경우 공부하는 시간도 적도 이해하는데 한계를 느끼게 된다.

여러 레퍼런스를 참고해도 이해하기 어려워 영상 위주의 강의라도
참고해서 보려고 한다.

과제하는 시간이 생각 보다 빨리 끝나서 같이 진행한 페어분과
종합 퀴즈를 풀었다. 같이 풀면서도 왜 이게 답인지 이해가 안 되는 부분이
꽤 됐었다.

참고
🔗 https://velog.io/@kho5420/Web-API-그리고-EndPoint
🔗 https://velog.io/@newdana01/TIL-RESTful-API
🔗 https://helpcenter.veeam.com/docs/vac/rest/offset_query_v3.html?ver=70

공부할 때 참고하기 좋은 사이트
🔗 https://helpcenter.veeam.com/docs/vac/rest/overview_v3.html?ver=70