RESTful API设计

（递归学习到RESTful API ，还有好多不对哦，加油吧！

因为前段设备层出不穷，必须有一个统一的机制，方便不同的前段设备和后端进行通信。这导致API架构的流行。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。

1. 协议

API与用户的通信协议，总是使用HTTPs协议

    2. 域名

应该尽量将API部署在专用域名之下  例如：http://api.example.com

    3. 版本

应该经API版本号放入URI(uniform resource identify)  例如：https://api.example.com/v1

    4. 路径（Endpoint）

在RESTful架构中，每个网址代表一种资源，所以网址中不能有动词，只能是名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的集合（collection），所以API中的名词也应该使用复数！

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

    5. HTTP动词

对资源的具体操作，由HTTP的动词表示

• GET（SELECT）：从服务器获取资源
• POST（CREATE）：在服务器新建资源
• PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）
• PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）
• DELETE（DELETE）：从服务器删除资源
• 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：删除某个指定动物园的指定动物

    6. 过滤信息

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

例如：

• ?limit=10：指定返回记录的数量
• ?offset=10：指定返回记录的开始位置。
• ?page=2&per_page=100：指定第几页，以及每页的记录数。
• ?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。

• ?animal_type_id=1：指定筛选条件

    7.状态码

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

 

    8.错误处理

如果状态码为4XX，就应该向用户返回出错信息，一般来说error作为键名，出错信息作为键值即可。

例如：{

            error:"Invalid API key"

        }

    9.返回结果

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

10.Hypermedia API

RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他api方法。

例如，当用户向api.example.com的根目录发出请求，会得到这样一个文档

link属性，用户读取这个属性就知道调用什么api

rel：表示这个api与当前网址的关系

href：api路径

title：api的标题

type：返回类型

学习站点：http://www.ruanyifeng.com/blog/2014/05/restful_api.html