RESTful API - 첫 번째 이야기

4. REST API 디자인 가이드

REST API 설계시 가장 중요한 항목은 2가지로 요약할 수 있다.

1. URI는 정보의 자원을 표현해야 한다.

2. 자원에 대한 행위는 HTTP Method (GET, POST, PUT, DELETE)로 표현한다.

4-1. REST API 중심 규칙

1. URI는 정보의 자원을 표현해야 한다. (리소스명은 동사보다는 명사를 사용)

GET /members/delete/1

위와 같은 방식은 RESTS를 제대로 적용하지 않은 URI

URI는 자원을 표현하는데 중점을 두어야 한다. delete와 같은 행위에 대한 표현이 들어가면 안된다.

2. 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE 등)으로 표현

위의 잘못된 URI를 HTTP Method를 통해 수정하면

DELETE /members/1

으로 수정할 수 있다.

회원 정보를 가져올 때는 GET, 회원을 추가할 때는 POST Method를 사용하여 표현한다.

회원 정보를 가져오는 URI

GET /members/show/1 (x)
GET /members/1        (o)

회원을 추가하는 URI

GET /members/insert/2 (x) - GET 메서드는 리소스 생성에 맞지 않는다.
POST /members/2       (o)

HTTP Method의 알맞은 역할

(RESTful API 첫번째 이야기 1-2 에 쓰여있고, 뒤에서도 설명)

POST : 해당 URI를 요청하면 리소스를 생성한다.

GET :  해당 리소스를 조회한다. 리소스를 조회하고 해당 도큐먼트에 대한 자세한 정보를 가져온다.

PUT : 해당 리소스를 수정한다.

DELETE : 리소스를 삭제한다.

4-2. URI 설계 시 주의할 점

1) 슬래시 구분자 (/)는 계층 관계를 나타내는 데 사용

http://restapi.example.com/houses/apartments
http://restapi.example.com/animals/mammals/whales

2) URI 마지막 문자로 슬래시(/)를 포함하지 않는다.

URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 한다. REST API는 분명한 URI를 만들어 통신을 해야하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않는다.

http://restapi.example.com/houses/apartments/ (X)
http://restapi.example.com/houses/apartments (0)

3) 하이픈(-)은 URI 가독성을 높이는 데 사용

URI를 쉽게 읽고 해석하기 위해, 불가피하게 긴 URI 경로를 사용해야 할 경우 하이픈을 사용해 가독성을 높인다.

4) 밑줄(_)은 URI에 사용하지 않는다.

가독성 문제로 밑줄 대신 하이픈을 사용하는 것이 좋다.

5) URI 경로에는 소문자가 적합하다.

URI 경로에 대문자 사용은 피해야 한다. 대소문자에 따라 다른 리소스로 인식하게 되기 때문이다. RFC 3986(URI 문법형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문이다.

6) 파일 확장자는 URI에 포함시키지 않는다.

http://restapi.example.com/members/soccer/345/photo.jpg (X)

REST API 에서는 메시지 바디 내용의 포맥을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다. Accept header를 사용한다.

4-3. 리소스 간의 관계를 표현하는 방법

REST 리소스 간에 연관 관계가 있을 수 있는데 이런 경우 다음과 같은 표현 방법을 사용한다.

/리소스/리소스 ID/관계가 있는 다른 리소스명

예) GET: /users/{userid}/devices (일반적으로 소유 'has'의 관계를 표현할 때)

만약에 관계명이 복잡하다면('has'의 관계가 아닐 때) 이를 서브 리소스에 명시적으로 표현하는 방법이 있다. 예를 들면 사용자가 '좋아하는(like)' 디바이스 목록을 표현해야 할 경우

GET : /users/{userid}/likes/devices (관계명이 애매하거나 구체적 표현이 필요할 때)

4-4. 자원을 표현하는 Collection과 Document

Collection과 Document에 대해 알면 URI 설계가 한 층 더 쉬워진다. Document는 단순히 문서 또는 한 객체, Collection은 문서들의 집합, 객체들의 집합으로 생각한다. 컬렉션과 도큐먼트는 모두 리소스라고 표현할 수 있으며 URI에 표현된다.

http:// restapi.example.com/sports/soccer

위 URI에서 sports라는 컬렉션과 soccer이라는 도큐먼트로 표현되어 있다고 생각하면 된다.

http:// restapi.example.com/sports/soccer/players/13

sports, players 컬렉션과 soccer, 13(13번인 선수)를 의미하는 도큐먼트로 URI가 이루어지게 된다. 여기서 중요한 점은 컬렉션은 복수로 사용하고 있다는 점이다. 좀 더 직관적인 REST API를 위해서 컬렉션과 도큐먼트를 사용할 때 단수/복수를 지켜준다면 이해하기 쉬운 URI를 설계할 수 있다.

RESTful Web Service HTTP methods

Collection URI (예) http:// example.com/resourses

GET : 컬렉션에 속한 자원들의 URI나 그 상세사항의 목록을 보여준다.

PUT : 전체 컬렉션은 다른 컬렉션으로 교체한다. 

POST : 해당 컬렉션에 속하는 새로운 자원을 생성한다. 자원의 URI는 시스템에 의해 할당된다.

DELETE : 전체 컬렉션을 삭제한다.

Element(Document) URI (예) http:// example.com/resoureces/item17

GET : 요청한 컬렉션 내 자원을 반환한다.

PUT : 해당 자원을 수정한다. 

POST : 해당 자원에 귀속되는 새로운 자원을 생성한다.

DELETE : 해당 컬렉션 내 자원을 삭제한다.

5. HTTP 응답상태 코드

잘 설계된 REST API는 URI만 잘 설계된 것이 아닌 그 리소스에 대한 응답을 잘 내어주는 것까지 포함되어야 한다. 정확한 응답의 상태코드만으로도 많은 정보를 전달할 수가 있기 때문에 응답의 상태코드 값을 명확히 돌려주는 것은 생각보다 중요한 일이다. 

[참고]

https://spoqa.github.io/2012/02/27/rest-introduction.html

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