REST API(Representational State Transfer API)

출처: https://meetup.toast.com/posts/92

1. REST API
웹(HTTP)의 장점을 최대한 활용할 수 있는 아키텍처.
자원을 이름으로 구분하여 해당 자원의 상태를 주고 받는 것.

2. 구성
2.1. 자원(RESOURCE): URI
2.2. 행위(Verb): HTTP METHOD
2.3. 표현(Representations)

3. REST의 특징
3.1. Uniform(유니폼 인터페이스)
URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일

3.2. Stateless(무상태성)
작업을 위한 상태정보를 따로 저장하고 관리하지 않음.
세션 정보나 쿠키정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만을 단순 처리하면 됨.
따라서 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않기때문에 구현이 단순해짐.

3.3. Cacheable(캐시 가능)
HTTP라는 기존 웹표준을 그대로 사용하기 때문에 웹에서 사용하는 기존 인프라를 그대로 활용 가능.
HTTP가 가진 캐싱 기능 적용이 가능.
HTTP 프로토콜 표준에서 사용하는 Last Modified태그나 E-Tag를 이용하면 캐싱 구현이 가능.

3.4. Self-descriptiveness(자체 표현 구조)
REST API 메세지만 보고도 쉽게 이해할 수 있음.

3.5. Client-Server 구조
REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보) 등을 직접 관리하는 구조로
각각의 역할이 확실히 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어듬.

3.6. 계층형 구조
REST 서버는 다중 계층으로 구성될 수 있으며 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고
PROXY, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있다.

4. REST API 디자인 가이드
- URI는 정보의 자원을 표현
- 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현

4-1. REST API 중심 규칙
1) URI는 정보의 자원을 표현해야 한다. (리소스명은 동사보다 명사를 사용)
나쁜 예) GET /members/delete/1 → delete와 같은 표현 지양
2) 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE 등)로 표현
1)을 수정하면, DELETE /members/1
회원정보를 가져올 때는 GET
회원 추가할 때는 POST METHOD 사용하여 표현
회원정보 가져오는 URI) GET /members/1
회원 추가) POST /members/2

■ 참고: HTTP METHOD의 알맞은 역할
POST: 해당 URI를 요청하면 리소스를 생성
GET: 해당 리소스 조회. 해당 도큐먼트에 대한 자세한 정보를 가져옴.
PUT: 해당 리소스를 수정
DELETE: 리소스를 삭제

4-2. URI 설계 시 주의할 점
1) 슬래시 구분자(/)는 계층 관계를 나타내는 데 사용
2) URI 마지막 문자로 슬래시(/)를 포함하지 않는다.
3) 하이픈(-)은 가독성을 높이는 데 사용
4) 밑줄(_)은 URI에 사용하지 않는다.
5) URI 경로에는 소문자가 적합
6) 파일 확장자는 URI에 포함시키지 않는다. (Accept header를 사용한다)
예) GET /members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg

4-3. 리소스 간의 관계를 표현하는 방법
/리소스명/리소스ID/관계가 있는 다른 리소스명
GET : /users/{userid}/devices

4-4. 자원을 표현하는 Collection과 Document
DOCUMENT는 단순히 문서로 이해해도 되고, 한 객체라고 이해해도 됨.
COLLECTION은 문서들의 집합, 객제들의 집합.
예1) http:// restapi.example.com/sports/soccer
예1 설명) 컬렉션: sports 도큐먼트: soccer
예2) http:// restapi.example.com/sports/soccer/players/13
예2 설명) 컬렉션: sports, players 도큐먼트: xoccer, 13
컬렉션은 복수, 도큐먼트는 단수로 하면 이해하기 쉬워짐.

5. HTTP 응답 상태 코드