Restful API设计规范
常用HTTP方法
- GET:读取(Read)
- POST: 新建(Create)
- PUT: 更新(Update)
- PATCH: 部分更新(Update)
- DELETE: 删除(Delete)
设计原则
Restful的核心思想是,客户端发出的指令由动词和名词构成,动词就是我们提到的HTTP方法,名词我们用来拼接URL。要注意:
- URI中尽量只包含名词 。
- 请求方式根据要进行的数据操作进行选择。
这样看来,RestfulAPI更像是一种规则。这里给大家提供一段RestAPI官网提供的视频:点击这里[https://youtu.be/llpr5924N7E]以及为无法翻墙的小朋友提供视频中的PPT截图。
不同情况下的定义示例
- 以id进行查找
GET /user/id - 查找所有
GET /users - 有些客户端只有GET和POST动作,我们需要进行覆盖,这时我们需要加上X-HTTP-Method-Override属性,给服务器说明HTTP方法
POST /user X-HTTP-Method-Override:PUT
说明服务器要匹配到PUT请求,而不是POST请求