RESTful API란? - showMeTheMoneyPrac/BE_Repo GitHub Wiki

REST(Representational State Transfer)의 약자로 자원을 이름으로 구분하여 해당 자원의 상태를 주고받는 모든 것을 의미합니다.

즉 REST란

  1. HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고,
  2. HTTP Method(POST, GET, PUT, DELETE)를 통해
  3. 해당 자원(URI)에 대한 CRUD Operation을 적용하는 것을 의미합니다.

CRUD Operation이란

CRUD는 대부분의 컴퓨터 소프트웨어가 가지는 기본적인 데이터 처리 기능인 Create(생성), Read(읽기), Update(갱신), Delete(삭제)를 묶어서 일컫는 말로

REST에서의 CRUD Operation 동작 예시는 다음과 같다.

Create : 데이터 생성(POST)

Read : 데이터 조회(GET)

Update : 데이터 수정(PUT)

Delete : 데이터 삭제(DELETE)

REST 구성 요소

REST는 다음과 같은 3가지로 구성이 되어있다.

  1. 자원(Resource) : HTTP URI
  2. 자원에 대한 행위(Verb) : HTTP Method
  3. 자원에 대한 행위의 내용 (Representations) : HTTP Message Pay Load

REST API 설계 기본 규칙

참고 리소스 원형

도큐먼트 : 객체 인스턴스나 데이터베이스 레코드와 유사한 개념컬렉션 : 서버에서 관리하는 디렉터리라는 리소스스토어 : 클라이언트에서 관리하는 리소스 저장소

1. URL는 정보를 자원을 표현해야 한다.**

resource는 동사보다는 명사를, 대문자 보다는 소문자를 사용한다. resource의 도큐먼트 이름으로는 단수 명사를 사용해야한다. resource의 컬렉션 이름으로는 복수 명사를 사용해야한다. resource의 스토어 이름으로는 복수 명사를 사용해야한다. ◦ Ex) GET /Member/1 → GET /members/1

2. 자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE 등)로 표현한다.

URL에 HTTP Method가 들어가면 안된다. ◦ Ex) GET /members/delete/1 → DELETE /members/1URL에 행위에 대한 동사 표현이 들어가면 안된다. (즉, CRUD 기능을 나타내는 것은 URL에 사용하지 않는다.) ◦ Ex) GET /members/show/1 → GET /members/1 ◦ Ex) GET /members/insert/2 → POST /members/2경로 부분 중 변화하는 부분은 유일한 값으로 대체한다. (즉, :id는 하나의 특정 resource를 나타내는 고유값이다.) ◦ Ex) student를 생성하는 route : POST /students ◦ Ex) id=12인 student를 삭제하는 route : DELETE /students/12

• REST API 설계 예시

1. URI는 동사보다는 명사를, 대문자보다는 소문자를 사용하여야 한다.

Bad Example http://seanlee/Running Good Example  http://seanlee/run  

2. 마지막에 슬래시 (/)를 포함하지 않는다.

Bad Example http://seanlee/test/ Good Example  http://seanlee/test

3.언더바 대신 하이폰을 사용한다.

Bad Example http://seanlee/test_blog Good Example  http://seanlee/test-blog

4. 파일확장자는 URI에 포함하지 않는다.

Bad Example http://seanlee/video.mp4 Good Example  http://seanlee/video  

5. 행위를 포함하지 않는다.

Bad Example http://seanlee/delete-post/1 Good Example  http://seanlee/post/1

RESTful이란?

RESTFUL이란 REST의 원리를 따르는 시스템을 의미합니다. 하지만 REST를 사용했다 하여 모두가 RESTful 한 것은 아닙니다.  REST API의 설계 규칙을 올바르게 지킨 시스템을 RESTful하다 말할 수 있으며 모든 CRUD 기능을 POST로 처리 하는 API 혹은 URI 규칙을 올바르게 지키지 않은 API는 REST API의 설계 규칙을 올바르게 지키지 못한 시스템은 REST API를 사용하였지만 RESTful 하지 못한 시스템이라고 할 수 있습니다.  

https://blog.kakaocdn.net/dn/Prbbr/btqUOBFqxzH/zhpIrKuFxPKI9QvRzmiBe1/img.png

RESTful 장점

  1. HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구출할 필요가 없다.
  2. HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해준다.HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
  3. REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다.
  4. 서버와 클라이언트의 역할을 명확하게 분리한다.

RESTful 단점

  1. 표준이 존재하지 않는다.
  2. 사용할 수 있는 메소드가 4가지 밖에 없다.
  3. HTTP Method 형태가 제한적이다.
  4. 구형 브라우저가 아직 제대로 지원해주지 못하는 부분이 존재한다. ◦ PUT, DELETE를 사용하지 못하는 점 ◦ pushState를 지원하지 않는 점