URI 설계 시 주의 할 점

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

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

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

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

• URI를 쉽게 읽고 해석하기 위해 긴 URI 경로를 사용하게 된다면 하이픈을 사용해 가독성을 높일 수 있다.

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

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

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

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

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