REST API 디자인 가이드

REST API 설계 시 가장 중요한 항목은 2가지로 요약 가능

 

• URI는 정보의 자원을 표현해야함
• 자원에 대한 행위는 HTTP Method(GET, POSt, PUT, DELETE)로 표현

---

REST API 중심 규칙

 

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

아래의 URI는 REST 방식을 제대로 적용하지 않은것 delete같은 표현은 들어가면 안됨.

GET /members/delete/1

  제대로 된 방식은

DELETE /members/1

이런식으로 표현해야한다.

회원정보를 가져 올 땐 GET, 회원 추가를 표현할 때에는 POST Method를 사용

---

회원정보를 가져오는 URI

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

회원을 추가할 때

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

 

---

 

URI 설계 시 주의점

 

슬래시 (/) 는 계층 관계를 나타냄

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

 

URI 마지막문자로 (/)를 포함하지 않음

 

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

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

 

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

URI를 쉽게 읽고 해석하기 위해서 불가피하게 긴 URI경로를 사용하게 된다면 하이폰을 사용해 가독성을 높인다.

 

언더바 (_)는 URI에 사용하지 않는다.

 

언더바는 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 언더바 대신 하이폰(-)을 사용하는게 좋다.

 

URI 경로에는 소문자가 적합

URI 경로에 대문자 사용은 피하도록하자. 대소문자에 따라 다른 리소스로 인식하기 때문

  RFC 3986 is the URI (Unified Resource Identifier) Syntax document

 

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

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

 

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

GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg

 

---

리소스 간의 관계를 표현하는 방법

 

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

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

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

만약 관계명이 복잡하다면 이를 서브 리소스에 명시적으로 표현하는 방법이 있다. 예를 들어 사용자가 '좋아하는'  디바이스 목록을 표현해야 할 경우 다음과 같은 형태로 사용된다.

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

 

---

자원을 표현하는 Collection과 Document

 

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

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

위의 URI를 보면 sports라는 Collection과 soccer라는 Document로 표현되고 있다고 생각하자

 

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

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

 

---

HTTP 응답 상태 코드

 

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

 

상태코드
200	클라이언트의 요청을 정상적으로 수행
201	클라이언트가 어떠한 리소스 생성을 요청, 해당 리소스가 성공적으로 생성됨(POST를 통한 리소스 생성 작업시)

 

상태코드
400	클라이언트의 요청이 부적절 할 경우 사용하는 응답 코드
401	클라이언트가 인증되지 않은 상태에서 보호된 리소스를 요청했을 때 사용하는 응답 코드
	(로그인 하지 않은 유저가 로그인 했을 때, 요청 가능한 리소스를 요청했을 때)
403	유저 인증상태와 관계 없이 응답하고 싶지 않은 리소스를 클라이언트가 요청했을 때
	(403 보다는 400이나 404를 사용할 것을 권고. 403자체가 리소스가 존재한다는 뜻이기 때문)
405	클라이언트가 요청한 리소스에서는 사용 불가능한 Method를 이용했을 경우 사용하는 응답 코드

 

상태코드
301	클라이언트가 요청한 리소스에 대한 URI가 변경 되었을 때 사용하는 응답 코드
	(응답시 Location header에 변경된 URI를 적어 줘야 한다)
500	서버에 문제가 있을 경우 사용하는 응답코드

---

출처

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

REST API 제대로 알고 사용하기 : NHN Cloud Meetup