REST API

 

REST (Representational State Transfer)

 - 자원을 이름으로 구분하여 해당 자원의 상태를 주고 받는 모든것을 의미 

 - 자원의 표현에 의한 상태 전달 

 - HTTP URI를 통해 자원을 명시하고 HTTP METHOD를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미 

 - CRUD Operation 

    - Create : 생성(POST)
    - Read : 조회(GET)
    - Update : 수정(PUT)
    - Delete : 삭제(DELETE)
    - HEAD: header 정보 조회(HEAD)

 

다음의 구성으로 이루어져있다.

 - 자원 (Resource)

      - URI, 해당 소프트웨어가 관리하는 모든 것, 모든 자원에 고유한 ID가 존재하고 이 자원은 Server에 존재한다. 

      - 자원을 구별하는 ID는 HTTP URI이다.

      - client는 URI를 이용해 자원을 지정하고 해당 자원의 상태에 대한 조작을 Server에 요청한다.

 

 - 행위 (Verb)

    - HTTP 프로토콜의 METHOD 사용한다.

    - GET, POST, PUT, DELETE와 같은 메서드를 제공한다.

    - 데이터가 요청되어지는 시점에서 자원의 상태를 전달한다.

 

 - 표현 (Representation of Resource) - 해당 자원을 표현하기 위한 이름

    - client가 자원의 상태에 대한 조작을 요청하면 Server는 이에 적절한 응답(Representation)을 보낸다.

    - REST에서 자원은 JSON, XML, TEXT, RSS 등의 여러 형태로 나타날 수 있다.

    -  일반적으로 JSON, XML을 통해 데이터를 주고 받음  

 

 => 웹의 기술과 HTTP 프로토콜을 활용하여 웹의 장점을 최대한 활용할 수 있는 아키텍쳐 스타일

 

 

REST의 특징 

 1. Server - Client 구조 

     - 자원이 있는쪽이 Server, 요청하는 쪽이 Client가 된다. 

 2. Stateless (무상태)

     - Client의 Context를 Server에 저장하지 않는다. (세션, 쿠키와 같은 정보 저장X -> 구현이 단순해짐)

     - Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리한다. (Client의 요청만을 단순 처리, 서비스의 자유도)

 3. Cacheable (캐시 처리 기능) 

     - HTTP 프로토콜을 그대로 사용하므로 웹의 기존 인프라를 그대로 활용할 수 있다. 

     - 대량의 요청을 효율적으로 처리하기 위해 캐시가 요구된다. 

     - 캐시 사용을 통해 응답시간이 빨라지고 트랜잭션이 발생하지 않아 전체 응답시간, 성능 등을 향상 시킬 수 있다.

 4. Layered System (계층화)

     - Client는 REST API Server만을 호출한다. 

     - REST Server는 다중 계층으로 구성될 수 있다.

 5. Code-On-Demand 

     - Server로부터 스크립트를 받아서 Client에서 실행한다.

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

     - URI로 지정한 Resource에 대한 조작을 통일하고 한정적인 인터페이스로 수행한다.

     - HTTP 표준 프로토콜을 따르는 모든 플랫폼에서 사용 가능하다. (특정 언어, 기술에 종속X)

 

 

 REST API 

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

 - REST는 HTTP 표준을 기반으로 구현하므로, HTTP를 지원하는 프로그램 언어로 클라이언트 - 서버를 구현할 수 있다.

 - 도큐먼트 : 객체 인스턴스나 DB의 레코드와 유사한 개념 

 - 컬렉션 : 서버에서 관리하는 디렉터리라는 리소스

 - 스토어 : 클라이언트에서 관리하는 리소스 저장소 

 

 

REST API 설계 기본 규칙 

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

2. 자원에 대한 행위는 HTTP Method로 표현한다. 

    - URI에 HTTP Method가 들어가면 안된다. 

    - URI 행위에 대한 동사 표현이 들어가서는 안된다. (CRUD는 URI에 사용X)

 

 

REST API 설계 규칙 

1. 슬래시 구분자 ( / )는 계층 관계를 나타낼때 사용한다. 

2. URI 마지막 문자로 슬래시를 포함하지 않는다. 

   - REST API는 분명한 URI를 만들어 통신해야하므로 혼동을 주지 않기 위해 사용 X

3. 하이픈 ( - )은 URI 가독성을 높이는데 사용한다. 

4. 밑줄 ( _ )은 URI에 사용하지 않는다.

5. URI 경로에는 소문자가 적합하다.  (대문자 사용 지양)

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