简简单单一篇文章,入门 RESTful URL 设计

HTTP 是 REST 的封装(implementation)。

Verbs / 动作

VerbSafe ?Idempotent?Scenario
OPTIONSYYget communication options(at least available verbs)
GETYYget resource
HEADYYsame with GET but no response body
PUTNYcreate(if not exists)/replace resource
DELETENYdelete resource
POSTNNcreate resource, unsafe operations there are no suitable verbs for
PATCHNNupdate resource partially

与 RPC 风格 web 服务比较

RPC(SOAP):

  • 只使用 HTTP POST 动作来传输封装打包的数据
  • 重点是方法
  • 重量级的

RESTful:

  • 对 CRUD 的标准 HTTP 动作(POST, GET, PUT/PATCH, DELETE)
  • 重点是资源,资源导向
  • 轻量级的,跨平台容易

REST-RPC:

不封装,也是非标准 HTTP 动作,看见方法信息的 URI

参考资料:

Web API Design – Crafting Interfaces that Developers Love, you need to input your email to receive the ebook. [MUST READ] ‼️
http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api
https://github.com/interagent/http-api-design

案例:

http://developer.github.com/v3

URL 设计原则

1、记住,REST 是以资源作为导向的。
2、对资源集使用复数名词形式(plural noun),如:/dogs
3、操作单个资源,使用 URL :/dogs/1234
4、使用正确的 HTTP 动词
5、共同的 CRUD 事例:

ResourcePOSTGETPUTPATCHDELETE
/dogscreate a new doglist dogsbulk update dogsXdelete all dogs
/dogs/1234Xshow a dogupdate a dogUpdate a dog partiallydelete a dog
    原文作者:xiaojianxu
    原文地址: https://www.jianshu.com/p/4acd11f058bc
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞