RESTful 이란?

이담호·2024년 10월 16일

1. REST 란?

월드 와이드 웹 (WWW) 과 같은 분산 하이퍼미디어 시스템을 위한 소프트웨어 개발 아키텍처의 한 형식이다.

Representational State Transfer 의 약자로 자원을 이름(자원의 표현)으로 구분해 해당 자원의 상태(정보)를 주고 받는 것을 의미한다.

즉, 자원(resource)의 표현(representation) 에 의한 상태 전달이다.

  • 자원(resource)의 표현(representation)
자원: 해당 소프트웨어가 관리하는 모든 것ex) 문서, 그림, 데이터, 해당 소프트웨어 자체 등
자원의 표현: 그 자원을 표현하기 위한 이름ex) DB의 학생 정보가 자원일 때, 
						‘students’를 자원의 표현으로 정한다.
  • 상태(정보) 전달
데이터가 요청되어지는 시점에서 자원의 상태(정보)를 전달한다.
JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적이다.

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

  • URI 와 URL 의 차이점
URL은 Uniform Resource Locator로 인터넷 상 자원의 위치를 의미한다.
반면 URI는 Uniform Resource Identifier로 인터넷 상의 자원을 식별하기 위한 
문자열의 구성으로,URI는 URL을 포함하게 된다. 
URI가 URL보다 포괄적인 범위라고 할 수 있다.

1.1 REST 구성요소

  • 자원(Resource) : URI
모든 자원에는 고유한 ID가 존재하고, 이 자원은 Server에 존재한다.
자원을 구별하는 ID는 '/exgroups/:exgroup_id'와 같은 HTTP URI 이다.
Client는 URI를 이용해 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 
Server에 요청한다.
  • 자원에 대한 행위(Verb) : Method
HTTP 프로토콜의 Method를 사용한다.
HTTP 프로토콜은 GET, POST, PUT, PATCH, DELETE의 Method를 제공한다.
  • 자원에 대한 표현 (Representation of Resource)
ClientServer가 데이터를 주고받는 형태로 JSON, XML, TEXT, RSS 등이 있다.
JSON, XML을 통해 데이터를 주고 받는 것이 일반적이다.

1.2 REST 특징

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

1.3 REST 단점

  • 표준이 존재하지 않는다.
  • HTTP Method 형태가 제한적이다.
  • 브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 값이 왠지 더 어렵게 느껴진다.

2. REST API 란?

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

최근 OpenAPI, 마이크로 서비스 등을 제공하는 업체 대부분은 REST API를 제공한다.

2.1 REST API 디자인 가이드

  1. URI 는 정보의 자원을 표현해야 한다.
  2. 자원에 대한 행위는 HTTP Method 로 표현한다.
    • 행위(Method) 는 URI 에 포함하지 않는다.

2.2 REST API 설계 규칙

  1. URI는 명사를 사용한다.(리소스명은 동사가 아닌 명사를 사용해야 한다.)

  2. 슬래시( / )로 계층 관계를 표현한다.

  3. URI 마지막 문자로 슬래시 ( / )를 포함하지 않는다.

  4. 밑줄( _ )을 사용하지 않고, 하이픈( - )을 사용한다.

  5. URI는 소문자로만 구성한다.

  6. HTTP 응답 상태 코드 사용

    • 클라이언트는 해당 요청에 대한 실패, 처리완료 또는 잘못된 요청 등에 대한 피드백을 받아야 한다.
  7. 파일확장자는 URI에 포함하지 않는다.
    Ex) http://dev-coco.tistory.com/restapi/220/photo.jpg (X)


3. RESTful 이란?

RESTful은 REST의 설계 규칙을 잘 지켜서 설계된 API를 RESTful한 API라고 한다.
즉, REST의 원리를 잘 따르는 시스템을 RESTful이란 용어로 지칭한다.

RESTful API는 이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것을 목적으로.
만약, 성능이 중요한 상황이라면 굳이 RESTful 한 API를 구현할 필요는 없다.


출처

https://dev-coco.tistory.com/97

https://velog.io/@somday/RESTful-API-이란

https://hahahoho5915.tistory.com/54

https://velog.io/@ahn0min/매번-헷갈려서-정리하는-URI-URL-URN

0개의 댓글