📌 개념
(API의 특징은 생략) REST는 “Representational State Transfer”의 약자이고, 로이 필딩 이라는 분의 대학원 논문에서 소개되었다. 웹에서 사용되는 데이터나 자원(Resource)을 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식
CRUD
Creat : Post 새로운 데이터 추가
Read : Get 데이터조회
Update : Put 데이터 전체 수정 , Patch 데이터 일부 수정
Delete : Delete 정보 삭제
URL 설계 규칙 : 소문자만사용, 하이픈("-") X 언더바 ("_") O , 확장자 표시X
✔ REST 성숙도 모델
REST의 성숙도 모델은 0,1,2,3 단계가 있고, 개발한 로이필딩은 모든 단계를 충족해야 REST API라 할 수 있다고 주장한다.
많은 기업에서 REST API 를 사용하지만 정작 3단계 까지 지키기 어렵기 때문에 2단계까지만 적용해도 좋은 API 디자인이라고 볼 수 있고, 이런 경우를 HTTP API 라고도 부른다.
0단계
- 0단계에서는 단순히 HTTP 프로토콜을 사용하기만 해도 된다.
- 0단계는 해당 API를 REST API라고 할 수는 없으며, 0단계는 REST API를 작성하기 위한 기본 단계
1단계
- 1단계에서는 개별 리소스(Resource)와의 통신을 준수해야 한다.
- 모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야하며 요청하고 받는 자원에 대한 정보를 응답으로 전달해야 한다는 것이 1단계의 핵심이다.
2단계
- CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둔다.
PUT 메서드와 PATCH 메서드도 구분하여 사용해야 합니다. PUT은 교체, PATCH는 수정의 용도로 사용
3단계
- 3단계는 HATEOAS(Hypertext As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용한다.
- 3단계의 요청은 2단계와 동일하지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성해야 한다.
❗ HTTP 메서드 사용시 유의할점
get메서드 사용시 서버 데이터를 변화시키지 않는 요청에 사용한다.post는 요청마다 새로운 리소스를 생성하고,put은 같은 리소스를 반환하여 구분 해야한다. 리소스를 반환하는 특징을 멱등성(idempotent)이라 한다.put은 전체 수정,patch는 일부 수정 용도로 사용하니, 구분해야한다
🌴 OPEN API
API를 이용하기 위해서는 API Key가 필요하다. API key는 서버의 문을 여는 열쇠입니다. 서버를 운용하는 데에 비용이 발생하기 때문에 서버 입장에서 아무런 조건 없이 익명의 클라이언트에게 데이터를 제공할 의무는 없습니다. (가끔 API key가 필요하지 않은 경우도 있습니다.)
API Key가 필요한 경우에는 로그인한 이용자에게 자원에 접근할 수 있는 권한을 API Key의 형태로 제공하고, 데이터를 요청할 때 API key를 같이 전달해야 원하는 응답을 받을 수 있습니다.
