认识 RESTful

RESTful 是一种网络应用程序的设计风格和开发方式，基于 HTTP，可以使用 XML 或 JSON 格式定义。
RESTful 适用于移动互联网厂商作为业务接口的场景，实现第三方 OTT 调用移动网络资源的功能，动作类型为新增、变更、删除所调用资源。

知乎 —— 怎样用通俗的语言解释REST，以及RESTful？
阮一峰的网络日志 —— 理解RESTful架构

RESTful 设计方法

域名

• 应该尽量将 API 部署在专用域名之下：https://api.example.com
• 如果确定 API 很简单，不会有进一步扩展，可以考虑放在主域名下：https://example.com/api/

版本（Versioning）

• 将API的版本号放入URL（不建议）
  http://www.example.com/app/1.0/foo
http://www.example.com/app/1.1/foo
http://www.example.com/app/2.0/foo

• 将版本号放在 HTTP 头信息中，但不如放入 URL 方便和直观。
  Github 采用这种做法。不同版本，可理解成同一种资源的不同表现形式，所以应该采用同一个 URL。
  版本号可以在 HTTP 请求头信息的 Accept 字段中进行区分（参见 Versioning REST Services）：
  Accept: vnd.example-com.foo+json; version=1.0
Accept: vnd.example-com.foo+json; version=1.1
Accept: vnd.example-com.foo+json; version=2.0

路径（Endpoint）

路径又称“终点”（endpoint），表示 API 的具体网址，每个网址代表一种资源（resource）

资源作为网址，只能有名词，不能有动词，而且所用的名词往往与数据库的表名对应。
此外，利用的 HTTP 方法可以分离网址中的资源名称的操作。
GET /products ：将返回所有产品清单
POST /products ：将产品新建到集合
GET /products/4 ：将获取产品 4
PATCH（或）PUT /products/4 ：将更新产品 4

API中的名词应该使用复数。无论子资源或者所有资源。
​举例来说，获取产品的 API 可以这样定义：
获取单个产品：http://127.0.0.1:8080/AppName/rest/products/1
获取所有产品：http://127.0.0.1:8080/AppName/rest/products

HTTP 动词

对于资源的具体操作类型，由 HTTP 动词表示。
常用的 HTTP 动词有下面四个（括号里是对应的 SQL 命令）。

• GET（SELECT）：从服务器取出资源（一项或多项）。
• POST（CREATE）：在服务器新建一个资源。
• PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
• DELETE（DELETE）：从服务器删除资源。

还有三个不常用的 HTTP 动词。

• PATCH（UPDATE）：在服务器更新(更新)资源（客户端提供改变的属性）。
• 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 /zoos/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。

状态码（Status Codes）

服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。

百度百科 https://baike.baidu.com/item/HTTP状态码

• 200 OK - [GET]：服务器成功返回用户请求的数据
• 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 作为键名，出错信息作为键值即可。

{
    error: "Invalid API key"
}

返回结果

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

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

其他

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

开发 REST API 接口

在开发 REST API 接口时，我们在视图中需要做的最核心的事是：

• 将数据库数据序列化为前端所需要的格式，并返回；
• 将前端发送的数据反序列化为模型类对象，并保存到数据库中。

序列化 反序列化

百度百科 https://baike.baidu.com/item/序列化