HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미한다.
최근의 서버 프로그램은 다양한 브라우저와 안드로이폰, 아이폰과 같은 모바일 디바이스에서도 통신을 할 수 있어야 한다.
이러한 멀티 플랫폼에 대한 지원을 위해 서비스 자원에 대한 아키텍처를 세우고 이용하는 방법을 모색한 결과, REST에 관심을 가지게 되었다.
모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재한다.
자원을 구별하는 ID는 ‘/groups/:group_id’와 같은 HTTP URI다.
Client는 URI를 이용해서 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청한다.
HTTP 프로토콜이 제공하는 GET, POST, PUT, DELETE 등의 Method를 사용한다.
Client가 자원의 상태(정보)에 대한 조작을 요청하면 Server는 이에 적절한 응답(Representation)을 보낸다.
REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 Representation으로 나타내어 질 수 있다. 최근에는 Key, Value를 활용하는 JSON을 주로 사용한다.
URI 과 URL의 차이점은?
URL은 Uniform Resource Locator로 인터넷 상 자원의 위치, 즉 어떤 파일의 위치를 의미한다. 반면 URI는 Uniform Resource Identifier로 인터넷 상의 자원을 식별하기 위한 문자열의 구성으로, URI는 URL을 포함하게 된다. 따라서 URI가 보다 포괄적인 범위라고 할 수 있다.
Server-Client(서버-클라이언트 구조)
Stateless(무상태)
Cacheable(캐시 처리 가능)
Layered System(계층화)
Code-On-Demand(optional)
Uniform Interface(인터페이스 일관성)
API(Application Programming Interface): 데이터와 기능의 집합을 제공하여 컴퓨터 프로그램간 상호작용을 촉진하며, 서로 정보를 교환가능 하도록 하는 것.
REST API의 정의: REST 기반으로 서비스 API를 구현한 것.
최근 OpenAPI(누구나 사용할 수 있도록 공개된 API: 구글 맵, 공공 데이터 등), 마이크로 서비스(하나의 큰 애플리케이션을 여러 개의 작은 애플리케이션으로 쪼개어 변경과 조합이 가능하도록 만든 아키텍처) 등을 제공하는 업체 대부분은 REST API를 제공한다.
사내 시스템들도 REST 기반으로 시스템을 분산해 확장성과 재사용성을 높여 유지보수 및 운용을 편리하게 할 수 있다.
REST는 HTTP 표준을 기반으로 구현하므로, HTTP를 지원하는 프로그램 언어로 클라이언트, 서버를 구현할 수 있다. 즉, REST API를 제작하면 델파이 클라이언트 뿐 아니라, 자바, C#, 웹 등을 이용해 클라이언트를 제작할 수 있다.
URI는 정보의 자원을 표현해야 한다.
Ex) GET /Member/1
-> GET /members/1
자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE 등)로 표현한다.
GET /members/delete/1
-> DELETE /members/1
GET /members/show/1
-> GET /members/1
GET /members/insert/2
-> POST /members/2
POST /students
DELETE /students/12
cf) 리소스 원형(Archetype: 원형, 전형)
컬렉션 리소스 : 서버에서 관리하는 디렉터리를 리소스로 표현하기 위해 사용되는 모델.
ex)https://api.com/users
도큐먼트 리소스 : 객체의 인스턴스 또는 데이터베이스 테이블의 특정 레코드와 유사한 단수 개념 모델.
ex)https://api.com/users/155
스토어 리소스 : 클라이언트에 의해서 관리될 수 있는 리소스 저장소 모델.
ex)https://api.com/users/155/devices
컨트롤러 리소스 : 특정 동작을 실행하도록 구현한 함수 개념 모델.
ex)https://api.com/users/155/devices/775/resend
슬래시 구분자(/ )는 계층 관계를 나타내는데 사용한다.
ex) http://restapi.example.com/houses/apartments
URI 마지막 문자로 슬래시(/ )를 포함하지 않는다.
http://restapi.example.com/houses/apartments/
❌하이픈( - )은 URI 가독성을 높이는데 사용.
불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높인다.
밑줄( _ )은 URI에 사용하지 않는다.
밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용하지 않는다.
URI 경로에는 소문자가 적합하다.
URI 경로에 대문자 사용은 피하도록 한다. RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문이다.
파일확장자는 URI에 포함하지 않는다.
http://restapi.example.com/members/soccer/345/photo.jpg
❌GET /members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg
⭕리소스 간에는 연관 관계가 있는 경우
/리소스명/리소스 ID/관계가 있는 다른 리소스명
GET /users/{userid}/devices
(일반적으로 소유 ‘has’의 관계를 표현할 때)GET /users/{userid}/likes/devices
(관계명이 애매하거나 구체적 표현이 필요할 때)cf) HTTP 응답 상태 코드
상태코드 | |
---|---|
200 | 클라이언트의 요청을 정상적으로 수행함 |
201 | 클라이언트가 어떠한 리소스 생성을 요청, 해당 리소스가 성공적으로 생성됨 (POST를 통한 리소스 생성 작업 시) |
400 | 클라이언트의 요청이 부적절 할 경우 사용하는 응답 코드 |
401 | 클라이언트가 인증되지 않은 상태에서 보호된 리소스를 요청했을 때 사용하는 응답 코드 (로그인 하지 않은 유저가 로그인 했을 때, 요청 가능한 리소스를 요청했을 때) |
403 | 유저 인증상태와 관계 없이 응답하고 싶지 않은 리소스를 클라이언트가 요청했을 때 사용하는 응답 코드 (403 보다는 400이나 404를 사용할 것을 권고. 403 자체가 리소스가 존재한다는 뜻이기 때문에) |
405 | 클라이언트가 요청한 리소스에서는 사용 불가능한 Method를 이용했을 경우 사용하는 응답 코드 |
301 | 클라이언트가 요청한 리소스에 대한 URI가 변경 되었을 때 사용하는 응답 코드 (응답 시 Location header에 변경된 URI를 적어 줘야 한다) |
500 | 서버에 문제가 있을 경우 사용하는 응답 코드 |
이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것.
RESTful한 API를 구현하는 근본적인 목적이 성능 향상에 있는 것이 아니라 일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는 것이 주 동기이니, 성능이 중요한 상황에서는 굳이 RESTful한 API를 구현할 필요는 없다.
Ex1) CRUD 기능을 모두 POST로만 처리하는 API
Ex2) route에 resource, id 외의 정보가 들어가는 경우(/students/updateName)
[Network] REST란? REST API란? RESTful이란? - 바로가기
[Interview_Question_for_Beginner] Part 1-1 Development common sense - 바로가기