restful 规范

Posted 2021-01-06 yzxing

什么是restful?

RESTful与技术无关，它代表的是一种软件架构风格,REST是Representational State Transfer的简称，中文翻译为“表征状态转移”或“表现层状态转化”。

RESTul API的设计规范

一 API与用户的通讯协议

　　1，总是使用HTTPs协议。

 二域名

 　　2, 尽量将API部署在专用域名

三体现版本号

　　3: 版本

　　　　1.  将版本信息放在URL中，如：https://api.example.com/v1/

　　　　2. 将版本信息放在请求头中。

 

四路径使用名词

　　4,视网络上任何东西都是资源，均使用名词表示（可复数）

　　　　https://api.example.com/v1/zoos

　　　　https://api.example.com/v1/animals

　　　　https://api.example.com/v1/employees

五HTTP请求方式

　　5, 对于资源的具体操作类型，由HTTP动词表示。

　　常用的HTTP动词有下面四个（括号里是对应的SQL命令）。

　　　　GET（SELECT）：从服务器取出资源（一项或多项）。

　　　　POST（CREATE）：在服务器新建一个资源。

　　　　PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。

　　　　DELETE（DELETE）：从服务器删除资源。

六过滤信息

　　6, 如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。

　　下面是一些常见的参数。

　　?limit=10：指定返回记录的数量

　　?offset=10：指定返回记录的开始位置。

　　?page=2&per_page=100：指定第几页，以及每页的记录数。

　　?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。

　　?producy_type=1：指定筛选条件

 七 ,状态码（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作为键名，出错信息作为键值即可。

九、返回结果

　　针对不同操作，服务器向用户返回的结果应该符合以下规范。

• GET /collection：返回资源对象的列表（数组）
• GET /collection/resource：返回单个资源对象
• POST /collection：返回新生成的资源对象
• PUT /collection/resource：返回完整的资源对象
• PATCH /collection/resource：返回完整的资源对象
• DELETE /collection/resource：返回一个空文档

10、返回结果中提供帮助链接

RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。注：Github就是这么做的

其他：服务器返回的数据格式，应该尽量使用JSON，避免使用XML。