REST API ?
REST의 구성
- 자원(Resource) : URI
- 행위(Verb) : HTTP METHOD
- 표현(Representations)
REST의 특징
1) Uniform
: URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍쳐 스타일
2) Stateless
: REST는 무상태성 성격을 갖는다. 이는 작업을 위한 상태정보를 따로 저장하고 관리하지 않는다.
그래서 API 서버는 들어오는 요청만을 단순히 처리하는 것이다.
이는 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해진다.
3) Cacheable
: REST의 가장 큰 특징으로 HTTP라는 기존 웹표준을 그대로 사용하기 때문에,
웹에서 사용하는 기존 인프라를 그대로 활용이 가능하다.
따라서 HTTP가 가진 캐싱 기능이 적용 가능하다.
4) Self-descriptiveness
: REST의 또 다른 큰 특징 중 하나는 REST API 메시지만 보고도 이를 쉽게 이해할 수 있는 자체 표현 구조로 되어 있다.
5) Client - Server 구조
: REST 서버는 API제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보)등을
직접 관리하는 구조로 각각의 역할이 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고
서로간의 의존성이 줄어들게 된다.
6) 계층형 구조
: REST 서버는 다중 계층으로 구성될 수 있으며 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 들 수 있다
또 PROXY, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있게 한다.
REST API 디자인 가이드
- URI는 정보의 자원을 표현해야 한다.
- 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현한다.
REST API 중심 규칙
1) URI는 정보의 자원을 표현해야 한다.(리소스명은 동사보다는 명사를 사용)
: GET /members/delete/1
2) 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현
: DELETE /members/1
- 회원 정보를 가져올 때 URI
GET /members/1
- 회원 추가 할 때 URI
POST /members/2
POST : POST를 통해 URI를 요청하면 리소스를 생성
GET : GET을 통해 해당 리소스를 조회, 해당 도큐먼트에 대한 자세한 정보를 가져옴
PUT : PUT을 통해 해당 리소스를 수정
DELETE : DELETE를 통해 리소스를 삭제
URI 설계 시 주의할 점
- 슬래시 구분자(/)는 계층 관계를 나타내는 데 사용
- URI 마지막 문자로 슬래시(/)를 포함하지 않는다.
- 하이픈(-)은 URI 가독성을 높이는데 사용
- 밑줄(_)은 URI에 사용하지 않는다.
- URI 경로에는 소문자가 적합하다.
- 파일 확장자는 URI에 포함시키지 않는다.
리소스 간의 관계를 표현하는 방법
- GET : /users/{userid}/devices
자원을 표현하는 Collection과 Document
- Collection은 복수
- Document는 단수
HTTP 응답 상태 코드
- 200 : 클라이언트의 요청을 정상적으로 수행
- 201 : 클라이언트가 어떠한 리소스 생성을 요청, 해당 리소스가 성공적으로 생성됨(POST를 통한 리소스 생성 작업 시)
- 400 : 클라이언트의 요청이 부적절 할 경우 사용하는 응답 코드
- 401 : 클라이언트가 인증되지 않은 상태에서 보호된 리소스를 요청했을 때 사용하는 응답 코드
... 그외
http://meetup.toast.com/posts/92
Chapter 07 객체.docx
