REST API

REST API 란

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

• RESTFUL 이란 REST 의 원리를 따르는 시스템을 의미합니다. 하지만 REST 를 사용했다 하여 모두가 RESTFUL 한 것은 아닙니다.
• REST API 의 가장 큰 특징은 각 요청이 어떤 동작이나 정보를 위한 것인지를 그 요청의 모습 자체로 추론이 가능한 것 입니다.
• URI 는 정보의 자원만 표현해야 하며, 자원의 행위는 HTTP Method 에 명시한다는 것입니다.

REST란

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

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

REST의 구성요소

• 1. 자원(Resource) - URI (접근대상)
  • 모든 자원에는 고유한 ID가 존재하고, 이 자원은 Server에 존재합니다.
  • 자원을 구별하는 ID는 '/exgroups/:exgroup_id'와 같은 HTTP URI 입니다.
  • Client는 URI를 이용해 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청합니다.
• 2. 행위(Verb) - Method (CRUD)
  • HTTP 프로토콜의 Method를 사용합니다.
  • HTTP 프로토콜은 GET, POST, PUT, PATCH, DELETE의 Method를 제공합니다. ( CRUD )GET Read : 정보 요청, URI가 가진 정보를 검색하기 위해 서버에 요청한다.

    GET	Read : 정보 요청, URI가 가진 정보를 검색하기 위해 서버에 요청한다.
    POST	Create : 정보 입력, 클라이언트에서 서버로 전달하려는 정보를 보낸다.
    PUT	Update : 정보 업데이트, 주로 내용을 갱신하기 위해 사용한다. (데이터 전체를 바꿀 때)
    PATCH	Update : 정보 업데이트, 주로 내용을 갱신하기 위해 사용한다. (데이터 일부만 바꿀 때)
    DELETE	Delete : 정보 삭제, (안전성 문제로 대부분 서버에서 비활성화한다.)

• 3. 표현 ( Representation of Resource )
  • Client와 Server가 데이터를 주고받는 형태로 JSON, XML, TEXT, RSS 등이 있습니다.
  • JSON, XML을 통해 데이터를 주고 받는 것이 일반적입니다.

REST의 특징

• 1. Server-Client (서버-클라이언트 구조)
  • 자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client가 됩니다.
    • REST Server는 API를 제공하고 비즈니스 로직 처리 및 저장을 책임지고,
    • Client는 사용자 인증이나 context( 세션, 로그인 정보 ) 등을 직접 관리하고 책임집니다.
    • 역할을 확실히 구분시킴으로써 서로 간의 의존성을 줄입니다.
• 2. Stateless (무상태)
  • HTTP 프로토콜은 Stateless Protocol이므로 REST 역시 무상태성을 갖습니다.
  • Client의 context를 Server에 저장하지 않습니다.
    • 즉, 세션과 쿠키와 같은 context 정보를 신경쓰지 않아도 되므로 구현이 단순해집니다.
  • Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리합니다.
    • 각 API 서버는 Client의 요청만을 단순 처리합니다.
    • 즉, 이전 요청이 다음 요청의 처리에 연관되어서는 안됩니다. ( DB에 의해 바뀌는 것은 허용 )
    • Server의 처리 방식에 일관성을 부여하기 때문에 서비스의 자유도가 높아집니다.
• 3. Cacheable (캐시 처리 기능)
  • 웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있습니다.
    • 즉, HTTP가 가진 가장 강력한 특징 중 하나인 캐싱 기능을 적용할 수 있습니다.
    • HTTP 프로토콜 표준에서 사용하는 Last-Modified Tag 또는 E-Tag를 이용해 캐싱을 구현합니다.
  • 대량의 요청을 효율적으로 처리할 수 있습니다.
• 4. Layered System (계층 구조)
  • Client는 REST API Server만 호출합니다.
  • REST Server는 다중 계층으로 구성될 수 있습니다.
    • 보안, 로드 밸런싱, 암호화 등을 위한 계층을 추가하여 구조를 변경할 수 있습니다.
    • Proxy, Gateway와 같은 네트워크 기반의 중간매체를 사용할 수 있습니다.
    • 하지만 Client는 Server와 직접 통신하는지, 중간 서버와 통신하는지는 알 수 없습니다.
• 5. Uniform Interface (인터페이스 일관성)
  • URI로 지정한 Resource에 대한 요청을 통일되고, 한정적으로 수행하는 아키텍처 스타일을 의미합니다.
  • HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하며, Loosely Coupling(느슨한 결함) 형태를 갖습니다.
    • 즉, 특정 언어나 기술에 종속되지 않음
• 6. Self-Descriptiveness (자체 표현)
  • 요청 메시지만 보고도 쉽게 이해할 수 있는 자체 표현 구조로 되어있습니다.

REST의 장단점

장점

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

단점

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

응답상태코드

• Informational 1XX: 정보를 제공하는 응답
• Successful 2XX : 성공적인 응답
  • 200 OK: 요청이 성공적으로 수행
• Redirection 3XX
  • 메시지 클라이언트의 요청을 완료하기 위해서 추가적인 행동이 필요한 경우
• Client Error 4XX
  • 클라이언트가 서버에게 잘못된 요청을 하는 경우
  • 401 Unauthorized: 인증이 필요한 페이지를 요청한 경우
  • 403 Forbiden: 허용되지 않은 메소드가 있을 때
  • 406 Not Acceptable: 허용 불가능
• Server Error 5XX
  • 서버에서 오류가 발생하여 정상적으로 요청을 처리할 수 없는 경우
  • 500 Internal Server Error: 웹 서버가 처리할 수 없음
  • 503 Service Unavailable: 서비스 제공불가, 서버 과부하, 서버 폭주

API 문서화 도구

• API Blueprint
• Swagger
  • 스웨거는 개발자가 REST 웹 서비스를 설계, 빌드, 문서화, 소비하는 일을 도와주는 대형 도구 생태계의 지원을 받는 오픈 소스 소프트웨어 프레임워크이다.

---

관련글 :

HTTP프로토콜

 

참고 :

REST API의 이해와 설계-#1 개념 소개

REST란? REST API 디자인 가이드

REST API 디자인 가이드

[REST API] REST / REST API 개념과 적용 + 코드 예제 (SpringBoot 기반)

[IT교양] 비전공자를 위한 API 이해하기 (feat. Open API, REST API)

REST란? REST API 와 RESTful API의 차이점

[네트워크] REST API란? REST, RESTful이란?

REST API 제대로 알고 사용하기 : NHN Cloud Meetup