RESTful API란?

Rest란?

HTTP URI를 통해 자원을 명시하고 HTTP 메서드를 통해 자원에 대한 CRUD Operation을 적용하는 것

HTTP 메소드와 CRUD

의미	HTTP method	CRUD operation
요청	GET	READ
작성	POST	CREATE
업데이트	PUT, PATCH	UPDATE
삭제	DELETE	DELETE

REST 6가지 원칙

• Uniform Interface
• Stateless
• Caching
• Client-Server
• Hierarchical system
• Code on demand

RESTful API

Rest 아키텍처를 모두 만족하는 API라는 뜻

RESTful 하게 API를 디자인한다는 것?

1. 리소스와 행위를 명시적이고 직관적으로 분리한다.

• 리소스는 URI로 표현되는데 리소스가 가리키는 것은 명사로 표현되어야 한다.
• 행위는 HTTP Method로 표현하고, GET(조회), POST(생성), PUT(기존 entity 전체 수정), PATCH(기존 entity 일부 수정), DELETE(삭제)을 분명한 목적으로 사용한다.

2. Message 는 Header와 Body를 명확하게 분리해서 사용한다.

• Entity에 대한 내용은 body에 담는다.
• 애플리케이션 서버가 행동할 판단의 근거가 되는 컨트롤 정보인 API 버전 정보, 응답받고자 하는 MIME 타입 등은 header에 담는다.
• header와 body는 http header 와 http body로 나눌 수도 있고, http body에 들어가는 json 구조로 분리할 수도 있다.

3. API 버전을 관리한다.

• 환경은 항상 변하기 때문에 API의 signature 가 변경될 수 있다.
• 특정 API 를 변경할 때는 반드시 하위 호환성을 보장해야 한다.

4. 서버와 클라이언트가 같은 방식을 사용해서 요청하도록 한다.

• 브라우저는 form-data 형식의 submit 으로 보내고 서버에서는 json 형태로 보내는 식의 분리보다는 json으로 보내든, 둘 다 form-data 형식으로 보내든 하나로 통일한다.
• 다른 말로 표현하자면 URI 가 플랫폼 중립적이어야 한다.

장점

Open API를 제공하기 쉽다
멀티플랫폼 지원 및 연동이 용이하다.
원하는 타입으로 데이터를 주고 받을 수 있다.
기존 웹 인프라(HTTP)를 그대로 사용할 수 있다.

단점

사용할 수 있는 메소드가 4 가지밖에 없다.
분산 환경에는 부적합하다.
HTTP 통신 모델에 대해서만 지원한다.

RESTful 하지 못한 경우

CRUD 기능을 모두 POST로만 처리하는 API

참고 사이트

네트워크 정리