Restful十大规范，优化API接口的实现

1. url规范

可以将API部署在专用域名之下:api.fandx.com

也可以使用目录的形式部署自己的api服务:www.fandx.com/api/

2.版本

需要在API中放入自己的版本号：www.fandx.com/api/v1

3.method规范

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

4.接口规范

5.接口命名（使用名词）

• www.fandx.com/api/v1/名词

6.状态码规范 code返回

• 200 成功
• 300 重定向
• 400 客户端错误
  • 401 用户没有权限令牌
  • 403 用户得到授权，但是访问是被禁止的
  • 404 访问的资源找不到
• 500 服务器内部错误

7.过滤规范，URL传参

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

8.https规范

9.返回结果规范

• get /collection 返回资源列表
• get /collection/resource 返回单个资源对象
• post /collection 返回新生成的资源对象
• put /collection/resource 返回完整的资源对象
• patch /collection/resource 修改局部，返回完整的资源对象
• delete /collection/resource 返回一个空文档

10.Hypermedia API

自动生成url 知道下一步应该怎么去做