REST API (+ REST, RESTful 이란?)

Benjamin·2022년 9월 7일

CS

목록 보기

1/10

REST API의 탄생

로이필딩에 의해 최초로 소개되었는데, 로이필딩은 HTTP의 주요 저자 중 한 사람으로 그 당시 웹(HTTP)설계의 우수성에 비해 제대로 사용되어지지 못하는 모습에 안타까워하며 웹의 장점을 최대한 활용할 수 있는 아키텍처로 REST를 발표했다.

아키텍처

시스템 구성 및 동작 원리를 나타낸다.

구성 요소 간의 관계 및 시스템 외부 환경과의 관계가 묘사된다.
-> 즉, 서비스의 동작 원리를 나타낸다.

REST API?

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

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

CRUD Operation

CRUD는 대부분의 컴퓨터 소프트웨어가 가지는 기본적인 데이터 처리 기능인 Create(생성), Read(읽기), Update(갱신), Delete(삭제)를 묶어서 일컫는 말로
REST에서의 CRUD Operation 동작 예시는 다음과 같다.

Create : 데이터 생성(POST)

Read : 데이터 조회(GET)

Update : 데이터 수정(PUT, PATCH)

Delete : 데이터 삭제(DELETE)

-> 즉, REST의 원리를 따르는 API

REST 구성요소

자원(resource) : URI
자원에 대한 행위(Verb) : HTTP Method
자원에 대한 행위의 내용(representations) : HTTP Message Pay Load

REST 특징

uniform (유니폼 인터페이스)
URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일
stateless (무상태성)
작업을 위한 상태정보를 따로 저장하고 관리하지 않는다.
세션 정보나 쿠키 정보를 별도로 저장하고 관리하지 않기 때문에, API 서버는 들어오는 요청만을 단순히 처리하면 된다. 때문에, 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해진다.
Cacheable(캐시 가능)
HTTP라는 기존 웹 표준을 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라를 그대로 활용 가능하다. 따라서 HTTP가 가진 캐싱 기능이 적용 가능하다. HTTP프로토콜 표준에서 사용하는 last-Modified태그나 E-Tag를 이용하면 캐싱 구현이 가능하다.
-self-descriptoveness(자체 표현 구조)
REST API 메시지만 보고도 이를 쉽게 이해할 수 있는 자체 표현 구조로 되어있다.
Client -Server구조
REST서버는 API제공, 클라이언트는 사용자 인증이나 컨텍스트 (세션, 로그인 정보) 등을 직접 관리하는 구조로 각각의 역할이 확실히 구분되기 때문에, 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어든다.
계층형 구조
REST 서버는 다중 계층으로 구성될 수 있으며, 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고, PROXY, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있게한다.

캐시

데이터나 값을 미리 복사해 놓는 임시 장소

last_Modified 태그와 E-Tag

last_Modified : HTTP 헤더에 서버가 알고있는 가장 마지막 수정된 날짜와 시각을 담고있다.
-> 이는 저장된 리소스가 이전과 같은지 유효성 검사자로 사용된다.

E-Tag : 특정 버전의 리소스를 식별하는 식별자이다.
웹 서버가 내용을 확인하고 변하지 않았으면, 웹 서버로 full 요청을 보내지 않기 때문에, 캐쉬가 더 효율적이게 되고, 대역폭도 아낄 수 있다. 만약 내용이 변경되었다면, 리소스 간 동시 다발적 수정 및 덮어쓰기 현상을 막는데 유용하게 사용된다.
만약, 특정 URL의 리소스가 변경된다면, 새로운 ETag가 생성된다, 이는 지문과 같은 역할을한다.

로드 밸런싱

서버가 처리해야 할 업무 혹은 요청을 여러 대의 서버로 나누어 처리하는 것.
한 대의 서버로 부하가 집중되지 않도록 트래픽을 관리해 각각의 서버가 최적의 퍼포먼스를 보일 수 있도록 하는것이 목적이다.

REST 단점

단점

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

REST API 디자인 가이드

REST API 설계 시 가장 중요한 항목 2가지

URI는 정보의 자원을 표현해야한다.
자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현한다.

REST API 중심 규칙

URI는 정보의 자원을 표현해야 한다.(리소스명은 동사보다는 명사 사용!)
GET /members/delete/1
-> REST를 제대로 적용하지 않은 RUI이다 : URI는 자원을 표현하는데 중점을 둬야한다. 즉, delete와 같은 행위에 대한 표현이 들어가서는 안된다.
자원에 대한 행위는 HTTP Method(GET,POST,PUT,DELETE...)로 표현
위의 잘못된 URI를 HTTP Method통해 수정해보면
DELETE /members/1
정보를 가져올 때 : GET, 정보를 추가할 때 : POST를 사용한다.
-> 회원정보 가져오는 URI
GET /members/show/1 (x) -> show 는 행위느낌
GET /members/1 (o)
-> 회원 추가하는 URI
GET /members/insert/2 (x) -> GET 메서드는 리소스 생성에 알맞지 않음
POST /members/2 (o)

+[참고] HTTP Method의 알맞은 역할
POST : 해당 URI요청시, 리소스를 생성한다.
GET : 해당 리소스를 조회한다. 리소스를 조회하고, 해당 도큐먼트에 대한 자세한 정보를 가져온다.
PUT : 해당 리소스를 수정한다.
DELETE : 해당 리소스를 삭제한다.

-> 이처럼, URI는 자원을 표현하는데 집중하고, 행위에 대한 정보는 HTTP Method를 통해 하는것이 REST API를 설계하는 중심규칙!

URI 설계 시 주의할 점

슬래시 구분자(/)는 계층 관계를 나타내는 데 사용
http://restapi.example.com/houses/apartments
URI 마지막 문자로 슬래시(/)를 포함하지 않는다.
URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며, URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 한다.
REST API는 분명한 URI를 만들어 통신을 해야하기 때문에, 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시를 사용하지 않는다.
http://restapi.example.com/houses/apartments/ (x)
하이픈(-)은 URI 가독성을 높이는데 사용
URI를 쉽게 읽고 해석하기 위해, 불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높일 수 있다.
밑줄(_)은 URI에 사용하지 않음
글꼴에 따라 다르긴하지만, 밑줄은 보기 어렵거나 밑줄로 인해 문자가 가려지기도 한다. 이런 문제를 피하기 위해 밑줄 대신 하이픈을 사용하는것이 좋다(가독성)
URI경로에는 소문자가 적합
대문자사용은 피하도록 한다. 대소문자에 따라 다른 리소스로 인식하게 되기 때문이다.
파일 확장자는 URI에 포함시키지 않는다.
http://restapi.example.com/members/soccer/345/photo.jpg (x)
메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI안에 포함시키지 않는다.
Accept header를 사용하도록 하자!
GET /members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept:image/jpg

리소스간 관계 표현법

REST 리소스 간에는 연간관계가 있을 수 있고, 이런 경우에는 다음과 같은 표현법을 사용
/리소스명/리소스ID/관계가 있는 다른 리소스명
ex) GET /users/{usersid}/devices (일반적으로 소유 'has'의 관계표현)

만약 관계명이 복잡하다면 이를 서브 리소스에 명시적으로 표현가능하다.
예를 들어, 사용자가 '좋아하는' 디바이스 목록을 표현해야 할 경우
GET /users/{userid}/likes/devices (관계명이 애매하거나 구체적 표현 필요시)
-> 하지만, RESTful하게 구현하려면 GET : /users/{userid}/device-liked을 추천한다.

자원을 표현하는 Collection과 Document

Document : 단순히 문서로 이해해도 되고, 한 객체라고 이해해도 된다.
Collection : 문서들의 집합, 객체들의 집합.
-> 둘 다 리소스이며 URI에 표현된다.
http:// restapi.example.com/sports/soccer
: sports라는 컬렉션과 soccer라는 도큐먼트로 표현되고있다.

http:// restapi.example.com/sports/soccer/players/13
:sports, player라는 컬렉션과 soccer, 13이라는 도큐먼트로 URI가 이루어진다.
여기서 중요한 점은 컬렉션은 복수로 사용하고있다는 것이다.
좀 더 직관적인 REST API를 위해 컬렉션과 도큐먼트를 사용할 때 단수/복수도 지켜준다면 이해하기 쉬운 URI를 설계할 수 있다.

HTTP 응답상태 코드

잘 설계된 REST API는 URI만 잘 설계된 것이 아닌, 그 리소스에 대한 응답을 잘 내어주는 것까지 포함되어야 한다.
정확한 응답의 상태코드만으로도 많은 정보를 전달할 수가 있기 때문에 응답 상태코드 값을 명확히 돌려주는 것은 생각보다 중요한 일이다.
혹시 200이나 4XX관련 특정 코드 정도만 사용하고 있다면 처리 상태에 대한 좀 더 명확한 상태코드값을 사용할 수 있기를 권장한다.
상태코드에 대해서는 몇가지만 정리하도록 하겠다.

상태코드 : 설명

200 : 클라이언트의 요청을 정상적으로 수행함
201 : 클라이언트가 어떠한 리소스 생성을 요청, 해당 리소스가 성공적으로 생성됨(POST를 통한 리소스 생성작업시)
400 : 클라이언트의 요청이 부적절 할 경우 사용하는 응답코드
401 : 클라이언트가 인증되지 않은 상태에서 보호된 리소스를 요청했을 때 사용하는 응답 코드
( 로그인 하지 않은 유저가, 로그인했을 때 사용가능한 리소스 요청 시)
403 : 유저 인증상태와 관계 없이 응답하고 싶지 않은 리소스를 클라이언트가 요청했을 때, 사용하는 응답코드 (403보다는 400이나 404사용 권고 : 403자체가 리소스가 존재한다는 뜻이므로)
405 : 클라이언트가 요청한 리소스에서는 사용 불가능한 메소드를 이용했을 경우 사용하는 응답코드
301 : 클라이언트가 요청한 리소스에 대한 URI가 변경되었을 때 사용하는 응답코드
(응답시, Location header에 변경된 URI를 적어야 한다.)
500 : 서버에 문제가 있을 경우 사용하는 응답코드

RESTful?

REST의 원리를 따르는 시스템을 의미한다.
하지만 REST를 사용했다 하여, 모두가 RESTful 한 것은 아니다.
REST API의 설계 규칙을 올바르게 지킨 시스템을 RESTful하다 말할 수 있으며, 그렇지 않은것은 REST API를 사용하였지만 RESTful 하지 못한 시스템이라고 할 수 있다.

참고
https://khj93.tistory.com/entry/네트워크-REST-API란-REST-RESTful이란
https://meetup.toast.com/posts/92

Benjamin

다음 포스트