RESTful API 파헤치기

RESTful API를 알기 위해서 REST가 무엇인지부터 알아봐야하는데 이를위한 설명부터 하겠습니다.

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

REST란

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

REST 구성 요소

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

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

REST의 특징

1. Server-Client(서버-클라이언트 구조)
2. Stateless(무상태)
3. Cacheable(캐시 처리 가능)
4. Layered System(계층화)
5. Uniform Interface(인터페이스 일관성)

REST의 장단점

장점

• HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구출할 필요가 없다.
• HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해 준다.
• HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
• Hypermedia API의 기본을 충실히 지키면서 범용성을 보장한다.
• REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다.
• 여러 가지 서비스 디자인에서 생길 수 있는 문제를 최소화한다.
• 서버와 클라이언트의 역할을 명확하게 분리한다.

단점

• 표준이 자체가 존재하지 않아 정의가 필요하다.
• HTTP Method 형태가 제한적이다.
• 브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 정보의 값을 처리해야 하므로 전문성이 요구된다.
• 구형 브라우저에서 호환이 되지 않아 지원해주지 못하는 동작이 많다.(익스폴로어)

REST의 필요성

• 애플리케이션 분리 및 통합
• 다양한 클라이언트의 등장
• 최근의 서버 프로그램은 다양한 브라우저와 안드로이폰, 아이폰과 같은 모바일 디바이스에서도 통신을 할 수 있어야 한다

---

자 이제 REST API와 RESTful API에 대해서 알아 보겠습니다.

REST API

API(Application Programming Interface)란

• 데이터와 기능의 집합을 제공하여 프로그램간 상호작용을 촉진해, 서로 정보를 교환하도록 하는것

REST API의 정의

• REST 기반으로 서비스 API를 구현한 것

REST API의 특징

• REST 기반으로 시스템을 분산해 확장성과 재사용성을 높여 유지보수 및 운용을 편리하게 할 수 있다.
• REST는 HTTP 표준을 기반으로 구현하므로, HTTP를 지원하는 프로그램 언어로 클라이언트, 서버를 구현할 수 있다.

REST API 설계 기본 규칙

(기본지식)

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

1. URI는 정보의 자원을 표현해야한다

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

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

• URI에 HTTP Method가 들어가면 안된다
  ex)GET/members/delete/1 -> DELETE/members/1
• URI에 행위에 대한 동사 표현이 들어가면 안된다.(즉 CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.)
  ex)GET/members/show/1 -> GET/members/1
  ex)GET/members/insert/2 -> GET/members/2
• 경로 부분 중 변하는 부분은 유일한 값으로 대체한다.
  ex)member를 생성하는 루트는 POST/members
  ex)id=1인 member를 삭제하는 루트는 DELETE/members/1

REST API 설계 규칙

1. 슬래시 구분자(/ )는 계층 관계를 나타내는데 사용한다.
   ex) http://restapi.example.com/houses/apartments
2. URI 마지막 문자로 슬래시(/ )를 포함하지 않는다.
   • URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 한다.
   • REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않는다.
     ex) http://restapi.example.com/houses/apartments/ (X)
3. 하이픈(- )은 URI 가독성을 높이는데 사용
4. 밑줄(_ )은 URI에 사용하지 않는다.
5. URI 경로에는 소문자가 적합하다.
   • URI 경로에 대문자 사용은 피하도록 한다.
   • RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문
6. 파일확장자는 URI에 포함하지 않는다.
   • REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다.
   • Accept header를 사용한다.
     ex) http://restapi.example.com/members/soccer/345/photo.jpg (X)
     ex) GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg (O)
7. 리소스 간에는 연관 관계가 있는 경우
   • /리소스명/리소스 ID/관계가 있는 다른 리소스명
     ex) GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)

---

RESTful API

RESTful이란

• RESTful은 일반적으로 REST라는 아키텍처를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어이다.
• 'REST API’를 제공하는 웹 서비스를 ‘RESTful’하다고 할 수 있다.
• RESTful은 REST를 REST답게 쓰기 위한 방법으로, 누군가가 공식적으로 발표한 것이 아니다.
• 즉, REST 원리를 따르는 시스템은 RESTful이란 용어로 지칭된다.

RESTful의 목적

• 이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것
• RESTful한 API를 구현하는 근본적인 목적이 성능 향상에 있는 것이 아니라 일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는 것이 주 동기이니, 성능이 중요한 상황에서는 굳이 RESTful한 API를 구현할 필요는 없다.
• RESTful 하지 못한 경우
  ex1) CRUD 기능을 모두 POST로만 처리하는 API
  ex2) route에 resource, id 외의 정보가 들어가는 경우(/students/updateName)