[Network] REST API를 설계하는 법, REST API란

REST API

REST의 정의

• "Representational State Transfer"의 약자
  • 자원을 이름(자원의 표현)으로 구분하여 해당 자원의 상태(정보)를 주고 받는 모든 것을 의미한다.
  • 간단히 정리하자면 자원(resource)의 표현(representation)에 의한 상태 전달이라고 볼 수 있다.
• 월드 와이드 웹(WWW)과 같은 분산 하이퍼미디어 시스템을 위한 소프트웨어 개발 아키텍처의 한 형식

REST는 API 작동 방식에 대해 조건을 부과하는 소프트웨어 아키텍처이다. 처음 REST는 인터넷 같은 복잡한 네트워크에서 통신을 관리하기 위한 지침으로 만들어졌다. REST 기반 아키텍처를 사용하면 대규모 고성능 통신을 안정적으로 지원할 수 있다. 또한 쉽게 구현하고 수정할 수 있다.

• REST는 네트워크 상에서 Client와 Server 사이의 통신 방식 중 하나이다.
• REST의 구체적인 개념
  • HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)를 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미한다.
    • 즉 REST는 자원 기반의 구조(ROA, Resource Oriented Architecture) 설계의 중심에 Resource가 있고 HTTP Method를 통해 Resource를 처리하도록 설게된 아키텍쳐를 의미한다.
      • 웹 사이트의 이미지, 텍스트, DB 내용 등의 모든 자원에 고유한 ID인 HTTP URI를 부여한다.
• CRUD Operation
  • Create : 생성(POST)
  • Read : 조회(GET)
  • Update : 수정(PUT)
  • Delete : 삭제(DELETE)
  • HEAD: header 정보 조회(HEAD)

REST의 장단점

• 장점
  • HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구축할 필요가 없다.
  • HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해준다.
  • HTTP 표준 프로토콜에 따르는 모든 플랫품에서 사용이 가능하다.
  • Hypermedia API 의 기본을 충실히 지키면서 범용성을 보장한다.
  • REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다.
  • 서버와 클라이언트의 역할을 명확하게 분리한다.
• 단점
  • HTTP method를 사용해 URI를 표현하기 때문에 다양한 인프라에서 사용이 가능하지만, 메서드의 형태가 제한적이라는 단점이 있다.
  • 표준이 존재하지 않는다. (표준 자체가 존재하지 않아서 정의가 필요햐다.)

REST가 필요한 이유

애플리케이션 분리 및 통합과 다양한 클라이언트의 등장

• 최근 서버 프로그램은 다양한 브라우저와 안드로이드, ios와 같은 다양한 모바일 운형체제에서도 통신을 할 수 있어야 한다. 이러한 멀티 플랫폼 지원을 위해 서비스 자원에 대한 아키텍쳐를 세우고 이용하는 방법을 모색한 결과, REST에 관심을 가지게 되었다.

REST의 구성 요소

1. 자원(Resource): URI
   • 모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재한다.
     • 자원을 구별하는 ID는 '/groups/:group_id'와 같은 HTTP URI다.
   • Client는 URI를 이용해서 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청한다.
   • `URI`란, 웹 서버가 리소스를 고유하게 식별할 수 있도록 하는 것으로써, URL과 URN이 있는데 일반적으로 URL을 사용한다.
2. 행위(Verb) : HTTP Method
   • HTTP 프로토콜의 Method를 사용한다.
3. 표현(Representation of Resource)
   • Client가 자원의 상태(정보)에 대한 조작을 요청하면 Server는 이에 적절한 응답(Representation)을 보낸다.
   • REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 Reprsentation으로 나타내어 질 수 있다.
   • JSON 혹은 XML을 통해 데이터를 주고 받는 것이 일반적이다.

REST 특징

1. Server-Client(서버 - 클라이언트 구조)
   • 자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client가 된다.
     • REST Server : API를 제공하고 비지니스 로직 처리 및 저장을 책임진다.
     • Client: 사용자 인증이나 context(세션, 로그인 정보) 등을 직접 관리하고 책임진다.
   • 서로 간 의존성이 줄어든다.
2. Stateless(무상태)
   • HTTP 프로토콜은 Stateless Protocol이므로 역시 무상태성을 갖는다.
   • Client의 context를 Server에 저장하지 않는다.
     • 즉, 세션과 쿠키와 같은 context 정보를 신경쓰지 않아도 되므로 구현이 단순해진다.

Context는 클라이언트의 다양한 상태정보를 의미한다. 맥락 정보는 context objeect를 통해 표현된다.
Context는 사용자가 발화한 시점의 클라이언트 상태 정보를 담아야 하며, 작성 가능한 클라이언트의 모든 상태 정볼르 맥락 정보로 나타내야 한다.

1. • Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리한다.
     • 각 API 서버는 Client의 요청만을 단순 처리한다.
     • 즉, 이전 요청이 다음 요청의 처리에 연관되어서는 안된다.
     • 물론 이전 요청이 DB를 수정하여 DB에 의해 바뀌는 것은 허용한다.
     • Server의 처리 방식에 일관성을 부여하고 부담이 줄어들며, 서비스의 자유도가 높아진다.
2. Cacheable(캐시 처리 가능)
   • 웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있다.
     • 즉, HTTP가 가진 강력한 특징 중 하나인 캐싱 기능을 적용할 수 있다.
     • HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능하다.
   • 다량의 요청을 효율적으로 처리하기 위해 캐시가 요구된다.
   • 캐시 사용을 통해 응답시간이 빨라지고 REST Server 트랜잭션이 발생하지 않기 때문에 전체 응답시간, 성능, 서버의 자원 이용률을 향상시킬 수 있다.
3. Layered System(계층화)
   • Client는 REST API Server만 호출한다.
   • REST Server는 다중 계층으로 구성될 수 있다.
     • API Server는 순수 비지니스 로직을 수행하고 그 앞단에 보안, 로드밸런싱, 암호화, 사용자 인증 등을 추가하여 구조상의 유연성을 줄 수 있다.
     • 또한 로드밸런싱, 공유 캐시 등을 통해 확장성과 보안성을 향상시킬 수 있다.
   • PROXY, 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있다.
4. Code-On-Demand(optional)
   • Server로 부터 스크립트를 받아서 Client에서 실행한다.
   • 반드시 충족할 필요는 없다.
5. Uniform Interface(인터페이스 일관성)
   • URI로 지정한다 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.

REST API의 개념

REST API란

1. API(Application Programming Interface)란
   • 데이터와 기능의 집합을 제공하여 컴퓨터 프로그램 간 상호작용을 촉진하며, 서로 정보를 교환가능 하도록 하는 것.
2. REST API의 정의
   • REST 기반으로 서비스 API를 구현한 것
   • 최근 OpenAPI(누구나 사용할 수 있도록 공개된 API: 구글 맵, 공공 데이터 등), 마이크로 서비스(하나의 큰 어플리케이션을 여러 개의 작은 어플리케이션으로 쪼개어 변경과 조합이 가능하도록 만든 아키텍처) 등을 제공하는 업체 대부분은 REST API를 제공한다.

REST API 설계 규칙

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

RESTful의 개념

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)

---

References : https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html