REST API ??
= 웹에서 사용되는 데이터나 자원을 HTTP URI로 표현하고 HTTP프로토콜을 통해 요청과 응답을 정의하는 방식이다.
<REST API 를 디자인하는 방법>
레오나르드 리차드슨이 제시한 REST API를 잘 적용하기 위한 4단계 모델
-
0단계 : HTTP 사용
** 0단계만 할 수 있지만 REST API라고 할 순 없다. -
1단계 : 개별 리소스와의 통신을 준수해야한다.
-예약 가능한 시간 확인 - 요청 시
/doctors/허준이라는 엔드포인트를 사용
-특정 시간에 예약 - 요청 시
slots라는 리소스의 123이라는 id를 가진 리소스를 엔드포인트로 사용
- 2단계 : CRUD 에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둔다.
**REST 성숙도 모델의 2단계까지 적용하면 대체적으로 잘 작성된 API라고 한다.
< HTTP 메서드를 사용할 때의 규칙 >
- GET메서드 같은 경우는 서버의 데이터를 변화시키지 않는 요청에 사용해야 한다.
- POST 메서드는 요청마다 새로운 리소스를 생성하고 PUT 메서드는 요청마다 같은 리소스를 반환한다. 이렇게 요청마다 같은 리소스를 반환하는 특징을 멱등하다고 한다. 그렇기 떄문에 멱등성을 가지는 메서드 PUT과 그렇지 않은 메서드 POST는 구분하여 사용해야 한다.
- PUT , PATCH 메서드도 구분해서 사용해야 한다. PUT은 교체 PATCH는 수정의 용도로 사용한다
- 3단계 : 하이어미디어 컨트롤을 적용한다. 3단계의 요청은 2단계와 동일하지만 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성한다. 3단계까지 무조건적으로 작성해야하는 것은 아니다.
Open API 와 API Key
Open API 는 누구에게나 열려있는 API로 정부에서 제공하는 공공데이터가 그 예시이다. Open API라도 정해진 이용 수칙이 있고 그에 따라 제한사항이 있을 수 있다.
API Key는 API를 이용하기 위해서는 API Key가 필요하다. API Key는 서버의 문을 여는 열쇠이다.
프론트엔드 개발자 일기