Restful API 设计规范
规范原则
- 接口返回数据即显示：前端仅做渲染逻辑处理；
- 渲染逻辑禁止跨多个接口调用；
- 前端关注交互、渲染逻辑，尽量避免业务逻辑处理的出现；
- 请求响应传输数据格式：JSON，JSON数据尽量简单轻量，尽量避免多级JSON的出现；
一、版本（Versioning）
应该将API的版本号放入URL。
https://api.example.com/v1/
另一种做法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观。Github采用这种做法。
二、路径（Endpoint）
路径又称"终点"（endpoint），表示API的具体网址。
在RESTful架构中，资源一般对应服务器端领域模型中的实体类。
路径规范
- 不用大写;
- 用中杠
-而不用下杠_; - 参数列表要encode;
- URI中要用名词表示资源集合，使用复数形式;
举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。
https://api.example.com/v1/zoos
https://api.example.com/v1/animals
https://api.example.com/v1/employees
不要使用：
三、HTTP动词
对于资源的具体操作类型，由HTTP动词表示。
常用的HTTP动词有下面五个（括号里是对应的SQL命令）。
- GET （SELECT）：从服务器取出资源（一项或多项）。
- POST （CREATE）：在服务器新建一个资源。
- PUT （UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
- PATCH （UPDATE）：在服务器更新资源（客户端提供改变的属性）。
- DELETE（DELETE）：从服务器删除资源。
还有两个不常用的HTTP动词。
- HEAD：获取资源的元数据。
- OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。
下面是一些例子。
- GET /zoos：列出所有动物园
- POST /zoos：新建一个动物园
- GET /zoos/ID：获取某个指定动物园的信息
- PUT /zoos/ID：更新某个指定动物园的信息（提供该动物园的全部信息）
- PATCH /zoos/ID：更新某个指定动物园的信息（提供该动物园的部分信息）
- DELETE /zoos/ID：删除某个动物园
- GET /zoos/ID/animals：列出某个指定动物园的所有动物
- DELETE /zoos/ID/animals/ID：删除某个指定动物园的指定动物
四、过滤信息（Filtering）
如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。
下面是一些常见的参数。
- ?limit=10：指定返回记录的数量
- ?offset=10：指定返回记录的开始位置。
- ?page=2&per_page=100：指定第几页，以及每页的记录数。
- ?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
- ?animal_type_id=1：指定筛选条件
参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如，GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。
五、状态码（Status Codes）
服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。
- 200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
- 201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
- 202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
- 204 NO CONTENT - [DELETE]：用户删除数据成功。
- 400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
- 401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
- 403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
- 404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
- 406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
- 410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
- 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
- 500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。
六、错误处理（Error handling）
如果状态码是4xx，就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。
{
"message": "系统异常",
"code": 500,
}
七、返回结果
响应基本格式
{
"message": "success",
"code": 0,
}
响应实体格式
{
"message": "success",
"code": 200,
"data": {
{
"roleId": 1,
"roleName": "管理员",
"remark": "管理菜单",
"createUserId": 1,
"menuIdList": null,
"createTime": "2018-08-25 14:35:39"
}
}
}
响应列表格式
{
"message": "success",
"code": 200,
"data": {
[{
"roleId": 1,
"roleName": "管理员",
"remark": "管理菜单",
"createUserId": 1,
"menuIdList": null,
"createTime": "2018-08-25 14:35:39"
}]
}
}
响应分页格式
{
"message": "success",
"code": 200,
"data": {
{
"total": 1, // 总条目数
"size": 10, // 每页显示个数
"current": 1, // 当前页数
"records": [{
"userId": 1,
"username": "admin",
"password": "9ec9750e709431dad22365cabc5c625482e574c74adaebba7dd02f1129e4ce1d",
"salt": "YzcmCZNvbXocrsz9dm8e",
"email": "root@dhcc.com.cn",
"mobile": "18018018018",
"status": 1,
"roleIdList": null,
"createUserId": 1,
"createTime": "2016-11-11 11:11:11"
}]
}
}
}
特殊内容规范
下拉框、复选框、单选框
由后端接口统一逻辑判定是否选中，通过checked标示是否选中，示例如下：
{
"message": "success",
"code": 200,
"data": {
[{
"id": 1,
"name": "XXX",
"code": "XXX",
"checked": 1
}, {
"id": 1,
"name": "XXX",
"code": "XXX",
"checked": 0
}]
}
}
禁止下拉框、复选框、单选框判定选中逻辑由前端来处理，统一由后端逻辑判定选中返回给前端展示；
Boolean类型
关于Boolean类型，JSON数据传输中一律使用1/0来标示，1为是/True，0为否/False；
日期类型
关于日期类型，JSON数据传输中一律使用字符串，具体日期格式因业务而定；
八、认证
1API的身份认证可选方案
aOAuth 2.0框架。（推荐）
b数据签名
九、数据格式
服务器返回的数据格式，统一使用JSON，避免使用XML。
十、致谢参考文档：
- https://www.yuque.com/xiangyisheng/kgcg9t/lt000v 《RESTful API》
- https://www.cnblogs.com/hujingnb/p/16464203.html 《RestAPI-烟草的香味》
