REST API
REST API에서 REST는 'Representational State Transfer' 의 약자로 웹에서 사용되는 데이터나 자원(Resource)을 HTTP URI로 표현하고, HTTP프로토콜을 통해 요청과 응답을 정의하는 방식이다.
REST API를 디자인하는 방법에는 0단게부터 3단계까지 총 4단계 모델이 있는데 실제로 엄밀하게 3단계까지 지키기는 매우 어렵다. 2단계까지만 적용해도 좋은 API 디자인이라고 볼 수 있고 이런 경우를 HTTP API라 부른다.
- 0단계 : HTTP 사용
- 1단계 : 개별 리소스와의 통신 준수
- 2단계 : HTTP 메소드 원칙 준수
- 3단계 : HATEOAS 원칙 준수
REST 성숙도 모델 - 0단계
단순히 HTTP 프로토콜을 사용하기만 하면 된다. 이 경우 해당 API는 REST API라고 보긴 어렵고 REST API를 작정하기 위한 기본 단계이다.
REST 성숙도 모델 - 1단계
개별 리소스와의 통신을 준수해야 한다. 모든 자원은 개별 리소스에 맞는 엔드포인트(Endpiont)를 사용해야하며 요청하고 받는 자원에 대한 정보를 응답으로 전달해야 한다는 것이다.
엔드 포인트 작성 시에는 동사, HTTP 메서드, 어떤 행위에 대한 단어 사용은 지양하고, 리소스에 집중해 명사 형태의 단어로 작성하는 것이 바람직한 방법이다.
요청에 따른 응답으로 리소스를 전달할 때에도 사용한 리소스에 대한 정보와 함께 리소스 사용에 대한 성공/실패 여부를 반환해야 한다.
REST 성숙도 모델 - 2단계
CRUD(Create, Read, Update, Delete)에 맞게 적절한 HTTP 메서드를 사용한다.
| METHOD | 역할 |
|---|---|
| POST | POST를 통해 해당 URI를 요청하면 리소스를 생성한다. |
| GET | GET을 통해 해당 리소스를 조화한다. 리소스를 조회하고 해당 도큐먼트에 대한 자세한 정보를 가져온다. |
| PUT | PUT을 통해 해당 리소스를 수정한다. |
| DELETE | DELETE를 통해 리소스를 삭제한다. |
REST 성숙도 모델 - 3단계
HATEOAS(Hypermedia As The Engine Of Application State) 라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용한다. 3단계의 요청은 2단계와 동일하지만 응답하는 리소스의 URI를 포함한 링크 요솔르 삽입하여 작성한다.
Open API
'Open' 이라는 키워에드에 맞게 누구에게나 열려있는 API이다. 그렇지만 무제한으로 이용할 수는 없고 API마다 정해진 이용수칙, 그 수칙에 따른 제한사항(가격, 정보의 제한 등)이 있다.
API Key
API를 이용하기 위해서는 API Key가 필요하다. API Key가 필요한 경우에는 로그인한 이용자에게 자원에 접근할 수 있는 권한을 API Key의 형태로 제공하고, 데이터를 요정할 때 API Key를 같이 전달해야 원하는 응답을 받을 수 있다.
