api接口规范

参考：API接口规范完整版本

协议

API与用户的通信协议，总是使用HTTPs协议，确保交互数据的传输安全。

域名

应该尽量将API部署在专用域名之下。

https://api.example.com

api版本控制

应该将API的版本号放入URL。

https://api.example.com/v{n}/

过滤信息

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

下面是一些常见的参数。

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

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

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

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

?producy_type=1：指定筛选条件

API 路径规则

路径又称"终点"（endpoint），表示API的具体网址。

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

举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。

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

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

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

接口返回模板：

{

    status:0,

    data:{}||[],

    msg:’’
}

status: 接口的执行的状态

=0表示成功

<0 表示有异常=""