首页 > 代码库 > Restful API 的设计规范(转)
Restful API 的设计规范(转)
1. URI
URI 表示资源,资源一般对应服务器端领域模型中的实体类。
URI规范
-
不用大写;
-
用中杠
-
而不用下杠_
; -
参数列表要encode;
-
URI中的名词表示资源集合,使用复数形式;
资源集合与单个资源
资源集合:
/zoos //所有动物园
/zoos/1/animals //id为1的动物园内的所有动物
单个资源:
/zoos/1 //id为1的动物园
/zoos/1;2;3 //id为1,2,3的动物园
2. Request
HTTP方法
通过标准HTTP方法对资源CRUD:
GET: 查询
GET /zoos
GET /zoos/1
GET /zoos/1/employees
POST: 创建单个资源。POST一般向“资源集合”型URI发起;··· javaascipt
POST /animals //新增动物
POST /zoos/1/employees //id为1的动物园的所有员工
PUT:更新单个资源(全量),客户端提供完整的更新后的资源。与之对应的是 PATCH,PATCH 负责部分更新,客户端提供要更新的那些字段。PUT/PATCH一般向“单个资源”型uri发起
PUT /animals/1
PUT /zoos/1
DELETE:删除
DELETE /zoos/1/employees/2
DELETE /zoos/1/employees/2;4;5
DELETE /zoos/1/animals //删除id为1的动物园内的所有动物
HEAD / OPTION 用的不多,就不多解释了。
安全性与幂等性
安全性:不会改变资源状态,可以理解为只读的;
幂等性:执行1次和执行N次,对资源状态改变的效果是等价的。
安全性和幂等性均不保证反复请求能拿到相同的response。以 DELETE 为例,第一次DELETE返回200表示删除成功,第二次返回404提示资源不存在,这是允许的。
3. Response
-
不要包装
response 的 body 直接就是数据,不要做多余的包装。错误示例:
{
"success":true,
"data":{"id":1,"name":"xiaotuan"},
}
-
各HTTP方法成功处理后的数据格式:
-
json格式的约定:
时间用长整形(毫秒数),客户端自己按需解析(moment.js)
不传null
字段
分页response
{
"paging":{"limit":10,"offset":0,"total":729},
"data":[{},{},{}...]
}
7. API演进
版本
常见的三种方式:
-
在uri中放版本信息:
GET /v1/users/1
-
Accept Header:
Accept: application/json+v1
-
自定义 Header:
X-Api-Version: 1
用第一种,虽然没有那么优雅,但最明显最方便。
URI失效
随着系统发展,总有一些API失效或者迁移,对失效的API,返回404 not found 或 410 gone;对迁移的API,返回 301 重定向。
来源:
https://segmentfault.com/a/1190000009476912?utm_source=weekly&utm_medium=email&utm_campaign=email_weekly
Restful API 的设计规范(转)