REST API

[ REST ]

▶ REST

REST(Representational State Transfer)는 웹에서 데이터를 전송하고 처리하는 방법을 정의한 인터페이스

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

웹 사이트의 이미지, 텍스트, DB 내용 등의 모든 자원에 고유한 ID인 HTTP URI를 부여함

 

▶ CRUD Operation

CRUD는 대부분의 컴퓨터 소프트웨어가 가지는 기본적인 데이터 처리 기능인

Create(생성), Read(읽기), Update(갱신), Delete(삭제)를 묶어서 일컫는 말

 

동작예시

• Create : 데이터 생성(POST)
• Read : 데이터 조회(GET)
• Update : 데이터 수정(PUT, PATCH)
• Delete : 데이터 삭제(DELETE)

 

▶ REST 구성 요소

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

 

▶ REST의 특징

1. Server-Client(서버-클라이언트 구조)

• 자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client가 됨
  • REST Server: API를 제공하고 비즈니스 로직 처리 및 저장을 책임
  • Client: 사용자 인증이나 context(세션, 로그인 정보) 등을 직접 관리하고 책임짐
• 서로 간 의존성이 줄어듬

 

2. Stateless(무상태)

• HTTP 프로토콜은 Statless Protocol이므로 REST도 Statless
  • 작업을 위한 상태정보를 따로 저장하고 관리하지 않음
  • 세션정보나 쿠키 정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만 단순히 처리하면 되서 서비스의 자유도가 높아지고 서버에 불필요한 정보를 관리하지 않아 구현이 단순해짐

 

3. Cacheable(캐시 처리 가능)

• 웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용 할 수 있음
  • 따라서 HTTP가 가진 특징 중 하나인 캐싱 기능을 적용할 수 있음
  • 캐시 사용을 통해 응답시간이 빨라지고 REST Sever 트랜잭션이 발생하지 않기 때문에 전체 응답시간, 성능, 서버의 자원 이용률을 향상시킬 수 있음
• HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능함

 

4. Layered System(계층화)

• Client는 REST API Sever만 호출함
  • REST Server는 다중 계층으로 구성될 수 있음
  • API Server는 순수 비즈니스 로직을 수행하고 그 앞단에 보안, 로드밸런싱, 암호화, 사용자 인증 등을 추가하여 구조상의 유연성을 줄 수 있음
  • 로드밸런싱, 공유 캐시 등을 통해 확장성과 보안성을 향상시킬 수 있음
  • PROXY, 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있다.

 

5. Uniform Interface(인터페이스 일관성)

• HTTP 표준만 따르면 안드로이드/IOS 플랫폼이든 특정 언어나 기술에 종속되지 않고 모든 플랫폼에서 사용할수 있으며 URI로 지정한 리소스에 대한 조작이 가능한 아키텍처 스타일
  • 즉 HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능함

 

▶ REST의 장단점

장점 

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

 

단점 

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

 

[ Rest API ]

Representational State Transfer API는 REST의 원리를 따르는 API

 

▶ REST API 기본 규칙

리소스 원형

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

 

REST API 설계 기본 규칙

1. URI는 정보의 자원을 표현해야함
   1. resource는 동사보다는 명사를, 대문자보다는 소문자를 사용
   2. resource의 도큐먼트 이름으로는 단수 명사를 사용
   3. resource의 컬렉션 이름으로는 복수 명사를 사용해야 한다.
      
      • ex) Member/1 → members/1
2. 자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE 등)로 표현
   1. URI에 HTTP Method가 들어가면 안됨
      • GET: /members/delete/1 → DELETE: /members/1
   2. URI에 행위에 대한 동사 표현이 들어가면 안됨
      • GET: /members/show/1 → GET: : /members/1
   3. 경로 부분 중 변하는 부분은 유일한 값으로 대체(즉 :id는 하나의 특정 resource를 나타내는 고유값)
      • DELETE: /students/5

 

▶ REST API 설계 규칙

1. 슬래시 구분자(/ )는 계층 관계를 나타내는데 사용
   • http://restapi.example.com/houses/apartments
2. URI 마지막 문자로 슬래시(/ )를 포함하지 않음
   • URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고 역으로 리소스가 다르면 URI도 달라져야 함
   • REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않음
     • http://restapi.example.com/houses/apartments/ (X)
3. 하이픈(- )은 URI 가독성을 높이는데 사용
   • 불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높임
   • 밑줄(_ )은 URI에 사용하지 않음
     • 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용하지 않음
4. URI 경로에는 소문자가 적합
   • URI 경로에 대문자 사용은 피하도록 한다.
5. RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문
   파일확장자는 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)
6. 리소스 간에는 연관 관계가 있는 경우
   • /리소스명/리소스 ID/관계가 있는 다른 리소스명
     • GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)

 

응답상태코드

• 1xx : 전송 프로토콜 수준의 정보 교환
• 2xx : 클라어인트 요청이 성공적으로 수행됨
• 3xx : 클라이언트는 요청을 완료하기 위해 추가적인 행동을 취해야 함
• 4xx : 클라이언트의 잘못된 요청
• 5xx : 서버쪽 오류로 인한 상태코드
  
  

[ RESTful ]

▶ RESTFUL

REST의 원리를 따르는 시스템을 의미.  REST를 사용했다 하여 모두가 RESTful 한 것은 아님

REST API의 설계 규칙을 올바르게 지킨 시스템을 RESTful하다 할수 있음

모든 CRUD 기능을 POST로 처리 하는 API 혹은 URI 규칙을 올바르게 지키지 않은 API는 REST API의 설계 규칙을 올바르게 지키지 못한 시스템은 REST API를 사용하였지만 RESTful 하지 못한 시스템

 

▶ RESTful의 목적

이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것
RESTful한 API를 구현하는 근본적인 목적이 성능 향상에 있는 것이 아니라 일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는 것이 주 동기이니, 성능이 중요한 상황에서는 굳이 RESTful한 API를 구현할 필요는 없음