[기초] REST API와 RESTful API

서지민·2024년 3월 31일

REST Restful restapi restful api

기초 정리

목록 보기

2/6

REST API와 RESTful API를 알아보자

1. REST

REST API에 대해 알아보기 위해서 우선 REST가 무엇인가에 대해 먼저 알아야 한다.

REST란?

Representational State Transfer의 약자로 자원을 이름(자원의 표현)으로 구분하여 해당 자원의 상태(정보)를 주고 받는 모든 것을 의미한다.
웹의 장점을 최대한 활용할 수 있는 아키텍처 스타일
REST는 네트워크 상에서 Client와 Server 사이의 통신 방식 중 하나
한 마디로 자원 이름으로 구분 + 구분한 자원 상태를 주고받는 모든 것!

조금 더 자세히 보면

HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미한다.
- ex) DB 선수정보가 자원이면 -> /players를 자원의 표현으로 정한다
즉, REST는 자원 기반의 구조(ROA, Resource Oriented Architecture) 설계의 중심에 Resource가 있고 HTTP Method를 통해 Resource를 처리하도록 설계된 아키텍쳐를 의미한다.
CRUD Operation
- Create : 생성(POST)
- Read : 조회(GET)
- Update : 수정(PUT)
- Delete : 삭제(DELETE)
- HEAD: header 정보 조회(HEAD)

REST 구성 요소

1. 자원(Resource): URI

모든 자원에 고유한 ID 존재, 이 자원은 Server에 존재
자원을 구별하는 ID는 ‘/groups/:group_id’와 같은 HTTP URI
Client는 URI를 이용해서 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청

2. 행위(Verb): HTTP 메서드(GET, POST, PUT, DELETE 등)

HTTP프로토콜의 메서드를 사용하여 자원에 대한 행위를 정의
이러한 메서드는 자원을 읽기, 생성, 업데이트, 삭제하는 데 사용

3. 표현(Representation)

Client가 자원의 상태(정보)에 대한 조작을 요청하면 Server는 이에 적절한 응답(Representation)을 보낸다.
REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 Representation으로 나타내어 질 수 있다
Client와 Server 간의 데이터 전달은 주로 JSON 또는 XML과 같은 포맷으로 이루어진다
이러한 표현은 클라이언트가 자원을 이해하고 처리할 수 있도록 해준다.

REST 특징

1. 무상태(Stateless)

HTTP 프로토콜은 Stateless Protocol이므로 REST 역시 무상태성을 갖는다.
Client의 context를 Server에 저장하지 않는다.
- 즉, 세션과 쿠키와 같은 context 정보를 신경쓰지 않아도 되므로 구현이 단순해진다.
Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리한다.
- 각 API 서버는 Client의 요청만을 단순 처리한다.
- 즉, 이전 요청이 다음 요청의 처리에 연관되어서는 안된다.
- 물론 이전 요청이 DB를 수정하여 DB에 의해 바뀌는 것은 허용한다.
- Server의 처리 방식에 일관성을 부여하고 부담이 줄어들며, 서비스의 자유도가 높아진다.

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

URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.
HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
- 특정 언어나 기술에 종속되지 않는다.

3. 캐시 처리 기능(Cacheable)

REST는 웹 표준 HTTP 프로토콜을 그대로 사용하기에 웹에서 수행되는 기존 인프라 그대로 활용가능
그 중 가장 강력한 기능중 하나인 "캐싱 기능" 사용 가능
HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능하다.
대량의 요청을 효율적으로 처리하기 위해 캐시가 요구되며, 이를 통해 응답시간이 빨라지고 REST Server 트랜잭션이 발생하지 않기에 전체 응답시간, 성능, 서버의 자원 이용률을 향상시킬 수 있다.

4. 계층화(Layered System)

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

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

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

6. Code-On-Demand(Optional)

서버에서 클라이언트에 실행 가능한 코드를 보낼 수 있다
클라이언트는 해당 코드 실행
반드시 충족할 필요는 X

REST의 장단점

장점

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

단점

표준이 존재하지 않는다.
사용할 수 있는 메소드가 4가지 밖에 없다.
HTTP Method 형태가 제한적이다.
브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 값이 왠지 더 어렵게 느껴진다.
구형 브라우저가 아직 제대로 지원해주지 못하는 부분이 존재한다.
- PUT, DELETE를 사용하지 못하는 점
- pushState를 지원하지 않는 점

2. REST API

그렇다면 REST API는 무엇일까?

REST API란?

REST를 기반으로 구현한 API
최근 OpenAPI(누구나 사용할 수 있도록 공개된 API: 구글 맵, 공공 데이터 등), 마이크로 서비스 등을 제공하는 업체 대부분은 REST API를 제공한다.

특징

사내 시스템들도 REST 기반으로 시스템을 분산해 확장성과 재사용성을 높여 유지보수 및 운용을 편리하게 할 수 있다.
REST는 HTTP 표준을 기반으로 구현하므로, HTTP를 지원하는 프로그램 언어로 클라이언트, 서버를 구현할 수 있다.
즉, REST API를 제작하면 델파이 클라이언트 뿐 아니라, 자바, C#, 웹 등을 이용해 클라이언트를 제작할 수 있다.

참고 리소스 원형

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

REST API 설계 기본 규칙

URI는 정보의 자원을 표현해야 한다
- resource는 동사보다 명사를, 대문자보다 소문자를 선호
- resource의 도큐먼트 이름으로는 단수 명사를 사용해야 한다
- resource의 컬렉션 이름으로는 복수 명사를 사용해야 한다
- resource의 스토어 이름으로는 복수 명사를 사용해야 한다
- ex) Ex) GET /Member/1 -> GET /members/1
자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE 등)로 표현
- URI에 HTTP Method가 들어가면 안된다
  Ex) GET /Member/1 -> GET /members/1
- URI에 행위에 대한 동사 표현이 들어가면 안된다.
  (즉, CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.)
- Ex) GET /members/show/1 -> GET /members/1
  Ex) GET /members/insert/2 -> POST /members/2
- 경로 중 변하는 부분은 유일한 값으로 대체
  (즉, id는 특정 resoure를 나타내는 고유값)
- Ex) student를 생성하는 route: POST /students
- Ex) id=12인 student를 삭제하는 route: DELETE /students/12

REST API 설계 규칙

파일 확장자는 URI에 포함 X
- 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)
하이픈(-)을 사용해서 URI의 가독성을 높인다
언더바(_)는 URI에 사용하지 않는다
슬래시 구분자(/)는 계층 관계를 나타내는데 사용
- Ex) http://restapi.example.com/houses/apartments
URI 마지막 문자로 슬래시(/)를 포함하지 않는다
- Ex) http://restapi.example.com/houses/apartments/ (X)
URI경로에는 소문자가 적합
리소스 간에 연관 관계가 있는 경우
- /리소스명/리소스ID/관계가 있는 다른 리로스명
- Ex) GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)

RESTful API

위에서 REST와 REST API에 대해 알아보았다

이를 토대로 RESTful API가 어떤 건지 바로 감이 올 것이다.

REST+ful API다 즉 REST스러움이 가득한 API라는 것이다

RESTful API?

정확한 정의를 알아보면

RESTful은 일반적으로 REST라는 아키텍처를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어
- ‘REST API’를 제공하는 웹 서비스를 ‘RESTful’하다고 할 수 있다.
RESTful은 REST를 REST답게 쓰기 위한 방법으로, 누군가가 공식적으로 발표한 것이 아니다
- 즉, REST 원리를 따르는 시스템은 RESTful이란 용어로 지칭된다.

RESTful의 목적

=> 이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것

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

RESTful 하지 못하는 경우

URI 규칙을 올바르게 지키지 않은 API, REST API의 설계 규칙을 올바르게 지키지 못한 시스템은 REST API를 사용하였지만 RESTful 하지 못한 시스템이라고 할 수 있다.
Ex1) CRUD 기능을 모두 POST로만 처리하는 API
Ex2) route에 resource, id 외의 정보가 들어가는 경우(/students/updateName)

기타

다음에는 mvc패턴과 RESTful API관련한 글을 작성해볼 예정이다.

출처 및 참고

출처(REST): https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html

서지민

효율 이전에 노력의 축적이 필요하다

이전 포스트

[기초] 프레임워크와 라이브러리

다음 포스트