RESTful架构设计指南

之前一直没注意到restful这个名词，一查才知道这词出现好久了，大致了解了下，也算是知道RESTful架构是什么意思。
说实话，虽然不知道这个架构是什么，但之前做接口一直用的就是这种方式，跟RESTful架构基本都是一样的。
猛一看：架构，其实还是那些东西，名词到是多出来好多。

资源 服务器上的图片、视频、文本、音乐等资源。
表现层 资源的表现形式，我理解就是后辍，.txt .html .mp3什么的。
状态转化 客户端用到的手段，客户端使用HTTP协议的四个方式：GET、POST、PUT、DELETE读取操作服务器数据。

其实都是我们一直在用的。restful架构详解可以见百度百科https://baike.baidu.com/item/RESTful/4406165?fr=aladdin

RESTful架构设计指南

协议

API与用户的通信协议，即HTTPs协议。

域名
尽量将API部署在专用域名，如：

https://api.example.com

如果API很简单，不会有什么扩展，可以放在主域名下，如：

https://example.org/api/

版本号
将API的版本号放入URL，如：

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

restful架构提倡将版本号放在HTTP头信息中，但没有放在URL中便于观察，还不方便。Github就是采用的放在url中。

路径
即API的具体网址。
在RESTful架构中，每个网址代表一种资源（resource），网址中不能有动词，只能有名词，且名词往往与数据库的字段名对应。
API中的名词也应该使用复数。有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，如：

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

HTTP动词
常用HTTP动词有下面五个

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

如：

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：删除某个指定动物园的指定动物

信息过滤
服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。就是网站前台常用的条件，分页，排序啥的

?limit=10：记录数量
?offset=10：开始位置
?page=2&per_page=100：第几页，每页的记录数。
?sortby=name&order=asc：顺序
?animal_type_id=1：条件

 

服务器状态码
服务器向用户返回的状态码和提示信息，如：

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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

4XX错误
如状态码是4xx，就应该向用户返回出错信息。一般返回的信息中将error作为键名，出错信息为值，便以观察排错。当然也可以定义文档团队之间查看，便以隐藏错误信息。

{error: "Invalid API key"}

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

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

Hypermedia API
RESTful API返回结果中最好提供链接，意思就是将包含域名等完整参数的连接返回，由服务器控制，假如更换域名，不可能将客户端所有版本一同更换，只需要修改服务器代码。
比如，当用户向api.example.com的根目录发出请求，会得到这样一个文档。

    {"link": {
      "rel":   "collection https://www.example.com/zoos",
      "href":  "https://api.example.com/zoos",
      "title": "List of zoos",
      "type":  "application/vnd.yourformat+json"
    }}

从上面可以看到，如果想获取当前用户的信息，应该去访问api.github.com/user，然后就得到了下面结果。

    {
      "message": "Requires authentication",
      "documentation_url": "https://developer.github.com/v3"
    }

上面代码表示，服务器给出了提示信息，以及文档的网址。

其他说明

1. API的身份认证应该使用OAuth 2.0框架。
2. 服务器返回的数据格式，应该尽量使用JSON，避免使用XML。