1.REST란
2.REST 구성
3.REST의 특징
(1) Uniform Interface(유니폼 인터페이스)
- Uniform Interface는 URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일
(2) Stateless(무상태성)
- REST는 무상태성 성격을 갖는다.
- 작업을 위한 상태정보를 따로 저장하고 관리하지 않는다.
- 세션 정보나 쿠키정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만을 단순히 처리하면 된다.
- 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해진다.
(3) Cacheable(캐시 가능)
- REST의 가장 큰 특징 중 하나는 HTTP라는 기존 웹표준을 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라를 그대로 활용 가능
- HTTP가 가진 캐싱 기능이 적용 가능
- HTTP 프로토콜 표준에서 사용하는 Last-Modified태그나 E-Tag를 이용하면 캐싱 구현이 가능
(4) Self-descriptiveness(자체 표현 구조)
- REST의 또 다른 큰 특징 중 하나는 REST API메시지만 보고 이를 쉽게 이해 할 수 있는 자체 표현 구조로 되어있다.
(5) Client-Server 구조
- REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트(세션,로그인 정보)등을 직접 관리하는 구조로 각각의 역할이 확실히 구분되기 때문에 클라이언트 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어든다.
(6) 계층형 구조
- REST 서버는 다중 계층으로 구성될 수 있으며 보안, 로드 벨런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고 PROXY,GATEWAY 같은 네트워크 기반의 중간매체를 사용할 수 있게 한다.
4.REST API 디자인 가이드
4-1.REST API 중심 규칙
# 회원정보 삭제 #
1. GET /members/delete/1 (X)
2. DELETE /members/1 (O)
# 회원정보 가져오는 URI #
1. GET /members/show/1 (X)
2. GET /members/1 (O)
# 회원정보 추가하는 URI #
1. GET /members/insert/1 (X)
2. POST /members/1 (O)
[HTTP METHOD의 알맞은 역할]
4-2.URI 설계 시 주의할 점
http://restapi.example.com/houses/villa
http://restapi.example.com/animals/mammals/dog
http://restapi.example.com/houses/villa/ (x)
http://restapi.example.com/houses/villa (o)
(3) 하이폰(-)은 URI 가독성을 높이는데 사용
URI를 쉽게 읽고 해석하기 위해, 불가피하게 긴 URI 경로를 사용하게 된다면 하이픈을 사용해 가독성을 높일 수 있다.
(4) 밑줄(_)은 URI에 사용하지 않는다.
글꼴에 따라 다르긴 하지만 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 한다.
이런 문제를 피하기 위해 밑줄 대신 하이픈(-)을 사용하는 것이 좋다.
(5) URI 경로에는 소문자가 적합
URI 경로에 대문자 사용은 피하도록 해야한다.
대소문자에 따라 리소스로 인식하게 되기 때문
RFC3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문
(6) 파일 확장자는 URI에 포함시키지 않는다.
REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다.
Accept Header를 사용한다.
http://restapi.example.com/members/soccer/345/photo.jpg (x)
GET / members/soccer/345/photo HTTP/1.1 Host : restapi.example.com Accept: image/jpg (o)
4-3.리소스 간의 관계를 표현하는 방법
/리소스명/리소스 ID/관계가 있는 다른 리소스명
ex) GET : /users/{userid}/devices (일반적으로 소유 'has'의 관계를 표현할 때)
GET : /users/{userid}/likes/devices (관계명이 애매하거나 구체적 표현이 필요할 때)
4-4.자원을 표현하는 Collection과 Document
http://restapi.example.com/sports/soccer
http://restapi.example.com/sports/soccer/players/13
5.HTTP 응답 상태 코드