TIL 19: RESTful API

URL Rules

1.1 마지막에 / 포함하지 않는다.

Bad

http://api.test.com/users/

Good

http://api.test.com/users

1.2 _(Underbar) 대신 -(dash)를 사용

(dash)의 사용도 최소한으로 설계. 정확한 의미나 표현을 위해 단어의 결합이 불가피한 경우 반드시 - (dash) 사용.

Bad

http://api.test.com/users/postComments

Good

http://api.test.com/users/post-comments

1.3 method 는 URL 에 포함하지 않는다

Bad

POST http://api.test.com/users/1/delete-post/1

Good

DELETE http://api.test.com/users/1/posts/1

1.4 URL 에는 되도록 자원만 표기한다

자원의 정보만 표기한다 (명사로 표기). 동사는 되도록 자제

Bad

http://products/show-image/1

Good

http://products/image/1

1.5 확장자(.png, .jpg) 는 사용하지 않는다

Bad

http://products/image/1.jpg

Good

http://products/image/1

source: https://library.gabia.com/contents/8339/

좋은 웹페이지 즐겨찾기