Rest API Architecture(작성 중)

 

Url Rules

맨 끝엔 / 를 포함하지 않는다.

Bad
https://api.currenjin.com/users/

Good
https://api.currenjin.com/users

Underbar(_) 대신 Dash(-) 를 사용한다.

• 단, Dash(-)의 사용도 최소한으로 설계한다. 불가피한 경우에만 사용한다.

Bad
https://api.currenjin.com/users/phone_number

Good
https://api.currenjin.com/users/phone-number

소문자를 사용한다.

Bad
https://api.currenjin.com/users/phoneNumber

Good
https://api.currenjin.com/users/phone-number

Method 는 Url 에 포함하지 않는다.

Bad
POST https://api.currenjin.com/users/1/delete-post/1

Good
DELETE https://api.currenjin.com/users/1/posts/1

Control resource 를 나타내는 Url 은 동작을 포함한다.

Bad
https://api.currenjin.com/posts/duplicating

Good
https://api.currenjin.com/posts/duplicate

Set Http Headers

Content-Location