你所需要了解的api接口的规范

                                 **

接口规范

**

一、协议
API与用户的通信协议，使用HTTPs协议。

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

三、版本（Version）
应该将API的版本号放入URL。 https://api.example.com/v1/

四、路径
路径又称"终点"（endpoint），表示API的具体网址。
在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。
举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。
https://api.example.com/v1/zoos
https://api.example.com/v1/animals
https://api.example.com/v1/employees

五、HTTP动词
对于资源的具体操作类型，由HTTP动词表示。
常用的HTTP动词有下面五个（括号里是对应的SQL命令）。
GET（SELECT）：从服务器取出资源（一项或多项）。
POST（CREATE）：在服务器新建一个资源。
下面是一些例子。
GET /zoos：列出所有动物园
POST /zoos：新建一个动物园

六、过滤信息
如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。
下面是一些常见的参数。
?limit=10：指定返回记录的数量
?offset=10：指定返回记录的开始位置。
?page=2&per_page=100：指定第几页，以及每页的记录数。
?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
?animal_type_id=1：指定筛选条件
参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如，GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。

七、状态码（Status Codes）
服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。
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，就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。

{
    error: "Invalid API key"
}

九、返回结果
针对不同操作，服务器向用户返回的结果应该符合以下规范。
GET /collection：返回资源对象的列表（数组）
GET /collection/resource：返回单个资源对象
POST /collection：返回新生成的资源对象

十、返回格式

1:分两种情况 1：接口级错误 2：业务级错误
错误调用返回方法 api_parser::response_error($errno,$errmsg);
正确调用方法     api_parser::response_success($data);
{"code":"0","msg":"Success","result":"data"}    

2:所有返回字段如果是null 必须转换成空字符串

十一、签名算法
public static function _genSign(array KaTeX parse error: Expected '}', got 'EOF' at end of input: … ksort(param);
$signPars{=}^{\prime \prime };foreach($param as $k => KaTeX parse error: Expected '}', got 'EOF' at end of input: … if (k != ‘sign’ && KaTeX parse error: Expected '}', got 'EOF' at end of input: … if (is_array(v)) {
$v=jso{n}_{e}ncode($v);
}
$signPars .= $k . ‘=’ . $v . ‘&’;
}
}
$sign=strtolower(md5($signPars));
return $sign;
}

十二、对于需要登录的接口需要传 token token算法
public static function _genToken(array $param){
$token=base64_{e}ncode(md5($param[‘username’].$param[‘password’]));
return $token;
}

十三、其他
（1）API的身份认证应该使用OAuth 2.0框架。****
（2）服务器返回的数据格式，应该尽量使用JSON，避免使用XML。