Achivement Goals

• REST API에 대해 이해할 수 있다.
  • REST API 문서를 읽을 수 있다.
  • REST API에 맞춰 디자인할 수 있다.
  • Open API와 API Key에 대해 이해할 수 있다.
• Postman이 무엇인지 이해하고 사용할 수 있다.
  • HTTP API 테스팅이 무엇인지 알 수 있다.
  • Postman을 사용하여 서버에 GET, POST 요청을 보내고 응답을 받을 수 있다.

REST API

• REST는 “Representational State Transfer” 의 약자
  웹상에서 사용되는 자원들을 HTTP URI로 표현하고, HTTP Method를 통해 상태를 정의하는 방식
  REST API를 사용한다는 것은 REST 아키텍처의 제약 조건을 준수한다는 것

코드스테이츠에서 운영중인 API 문서 Message States Server
http://3.36.72.17:3000

Endpoint

• root-endpoint(혹은 root-URL): 요청을 보내는 주소의 시작점
• path: path는 요청을 보내는 리소스를 정의
  ex)https://api.github.com/user 에서 'user'가 path

1. 메시지 조회

Request
GET -> http://3.36.72.17:3000/username/messages
파라미터를 사용하여 특정 키를 확인 할 수 있다.

2. 메시지 추가

Request
POST -> http://3.36.72.17:3000/username/messages

3. 메시지 초기화

Request
POST -> http://3.36.72.17:3000/username/clear

REST API 디자인

REST API는 공식적으로 정해진 규격이 존재하지 않는다. 그렇기 때문에 REST API 특징(원칙)에 맞춰 약간씩 다른 모습을 함. 하지만 REST API 모범사례가 논의되고 통합되고 있기 때문에 모범적인 API 디자인이 형성되고 있음

5가지의 기본적인 REST API 디자인 가이드
위의 사이트를 보면 5가지의 REST API 디자인 가이드가 나오는데 메소드나 헤더, 파라미터까지 API를 짤 때 주의해야할 점을 확인 할 수 있다.

OPEN API, API Key

• 오픈 API(Open Application Programming Interface, Open API, 공개 API) 또는 공개 API는 개발자라면 누구나 사용할 수 있도록 공개된 API
  하나의 웹 사이트에서 자신이 가진 기능을 이용할 수 있도록 공개한 프로그래밍 인터페이스

• API Key : api를 사용하기 위한 말 그대로의 key, 회원가입 같은 방법으로 api를 이용할 권한을 주게 되고 그 권한이 api key의 형태로 되어있음.

Postman

REST API test program
REST API를 테스트하기 위한 프로그램으로 밑에 나와있는 것과 같이 GET을 이용해 메시지를 조회 가능하며 POST를 이용해 추가 역시 가능하다. 이 서버의 경우 GET 과 POST 만을 채용하고 있기 때문에 PATCH나 DELETE 는 이용할 수 없다. 이렇게 서버의 API 마다 각자 필요한 것을 API로 만들어 놓을 수 있다.

API 테스트 자습서
API에 관련된 정보를 얻을 수 있는 사이트

POST의 경우
body 작성법이 다양하게 존재하기 때문에
https://learning.postman.com/docs/sending-requests/requests/#sending-body-data
이 사이트를 보고 자신에 맞는 작성법을 이용하면 될것 같다.

---

마지막으로...

금요일 내용을 조금 더 많이 살펴보고 공부를 더 해야겠다.