RESTful한 URL이란?

 

1. 소문자 사용. 

카멜방식이 아닌 소문자를 사용하여 작성.

 

잘못된 예

https://pythontoomuchinformation.tistory.com/users/postLikes

올바른 예

https://pythontoomuchinformation.tistory.com/users/post-likes

 

2. 언더바를 대신 하이픈 사용.

 

잘못된 예

https://pythontoomuchinformation.tistory.com/users/post_likes

올바른 예

 

https://pythontoomuchinformation.tistory.com/users/post-likes

 

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

슬래시는 계층을 구분하는 것으로, 마지막에는 사용하지 않는다.

 

잘못된 예

https://pythontoomuchinformation.tistory.com/users/post-likes/

올바른 예

 

https://pythontoomuchinformation.tistory.com/users/post-likes

 

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

행위는 URL대신 Method를 사용하여 전달한다.(GET, POST, PUT, DELETE 등)

 

잘못된 예

POST https://pythontoomuchinformation.tistory.com/user/1/delete-post/1

올바른 예

 

DELETE https://pythontoomuchinformation.tistory.com/user/1/posts/1

 

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

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

Accept header를 사용하도록 한다.

 

잘못된 예

http://restapi.example.com/users/photo.jpg

올바른 예

 

GET http://restapi.example.com/users/photo

HTTP/1.1 Host: restapi.example.com Accept: image/jpg

 

6. 가급적 전달하고자하는 자원의 명사를 사용하되, 컨트롤 자원을 의미하는 경우 예외적으로 동사를 허용한다.

 

잘못된 예

http://restapi.example.com/posts/duplicating

올바른 예

 

http://restapi.example.com/posts/duplicate

 

---

🔽 REFERENCE

[REST API] URL 규칙, RESTful한 URL이란?