RestAPI 주소 설계 규칙

1. RestAPI 주소 설계 규칙

 

1. 소문자를 사용한다.

대문자는 때로 문제를 일으키는 경우가 있기 때문에 URI를 작성할 때는 소문자를 선호한다.

❌http://dev-cool.tistory.com/users/Post-Comments
⭕http://cocoon1787.tistory.com/users/post-comments

 

2. 언더바(_) 대신 하이픈(-)을 사용한다.

가독성을 위해 긴 Path를 표현하는 단어는 하이픈(-)으로 구분하는 것이 좋다.

프로그램의 글자 폰트에 따라 언더바 문자는 부분적으로 가려지거나 숨겨질수 있다.

❌http://dev-cool.tistory.com/users/post_comments
⭕http://dev-cool.tistory.com/users/post-comments

 

3. 마지막에 슬래시(/)를 포함하지 않는다.

후행 슬래시(/)는 의미가 전혀 없고 혼란을 야기할 수 있다.

URI내의 모든 문자는 리소스의 고유 ID에 포함된다. URI 가 다르면 리소스도 다르기 때문에 명확한 URI를 생성해야한다.

❌http://dev-cool.tistory.com/users/
⭕http://dev-cool.tistory.com/users

 

4. 행위를 포함하지 않는다.

행위는 URI 대신 Method를 사용하여 전달한다.

❌ POSThttp://dev-cool.tistory.com/users/post/1
⭕ PUThttp://dev-cool.tistory.com/users/1

 

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

파일 확장자는 URI에 포함하지 말아야한다. 대신 Content-Type 헤더를 통해 전달되는대로 미디어 타입을 사용하여 body 콘텐츠를 처리하는 방법을 결정한다.

Rest API 클라이언트는 HTTP에서 제공하는 형식 선택 메커니즘인 Accept 요청 헤더를 활용하도록 권장해야한다.

❌ http://dev-cool.tistory.com/users/photo.jpg
⭕ GET http://dev-cool.tistory.com/users/photo
   
   HTTP/1.1 Host: dev-cool.tistory.com Accept: image/jpg

목차로 돌아가기