REST API 설계하기
참고 리소스 원형
- 도큐먼트 : 객체 인스턴스나 데이터베이스 레코드와 유사한 개념
- 컬렉션 : 서버에서 관리하는 디렉터리라는 리소스
- 스토어 : 클라이언트에서 관리하는 리소스 저장소
1. REST API 설계 기본 규칙
1. URI는 정보의 자원을 표현해야 한다.
1-1 resource는 동사보다는 명사를, 대문자보다는 소문자를 사용한다
1-2 resource의 도큐먼트 이름으로는 단수 명사를 사용해야 한다.
1-3 resource의 컬렉션 이름으로는 복수 명사를 사용해야 한다.
1-4 resource의 스토어 이름으로는 복수 명사를 사용해야 한다.
2. 자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE 등)로 표현한다.
2-1.URI에 HTTP Methon가 들어가면 안된다.
○ Ex) GET /members/delete/1 -> DELETE /members/1
2-2. URI에 행위에 대한 동사 표현이 들어가면 안된다. 즉 CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.
○ Ex) GET /members/show/1 -> GET /members/1
○ Ex) GET /members/insert/2 -> POST /members/2
2-3. 경로 부분 중 변하는 유일한 값으로 대체한다.
○ (즉, :id는 하나의 특정 resource를 나타내는 고유값이다.)
○ Ex) student를 생성하는 route: POST /students
○ Ex) id=12인 student를 삭제하는 route: DELETE /students/12
2.REST API 설계 규칙
- 슬래시 구분자(/ )는 계층 관계를 나타내는데 사용한다.
○ Ex) http://restapi.example.com/houses/apartments
- URI 마지막 문자로 슬래시(/ )를 포함하지 않는다.
○ URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 한다.
○ REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않는다.
○ Ex) http://restapi.example.com/houses/apartments/ (X)
- 하이픈(- )은 URI 가독성을 높이는데 사용
○ 불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높인다.
- 밑줄(_ )은 URI에 사용하지 않는다.
○ 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용하지 않는다.
- URI 경로에는 소문자가 적합하다.
○ URI 경로에 대문자 사용은 피하도록 한다.
○ RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문
- 파일확장자는 URI에 포함하지 않는다.
○ REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다.
○ Accept header를 사용한다.
○ Ex) http://restapi.example.com/members/soccer/345/photo.jpg (X)
○ Ex) GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg (O)
- 리소스 간에는 연관 관계가 있는 경우
○ /리소스명/리소스 ID/관계가 있는 다른 리소스명
○ Ex) GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)
