API 接口规范

女爷i 2024-03-25 23:16 22阅读 0赞

## **协议** ##

API 与客户端通讯协议主要包含 **http** 和 **https**，建议使用 **https** 确保交互数据的传输安全。

## **域名** ##

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

![e1275580b2f84510fb655e5e4694cfaf.png][]

如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。

![be40d84757d68f20c045e6db3f5d2b70.png][]

## **api版本控制** ##

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

![c1ad25a4d98aefc43e8a72baf629ac2f.png][]

另一种做法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观。Github采用这种做法。

采用多版本并存，增量发布的方式。

*  **v\{n\}**： n代表版本号,分为整形和浮点型

*  **整型版本号**：大功能版本发布形式；具有当前版本状态下的所有API接口 。例如：v1、v2

*  **浮点型版本号**：为小版本号，只具备补充api的功能，其他api都默认调用对应大版本号的api。例如：v1.1、 v2.2

## **API 路径规则** ##

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

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

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

![ae280bf6439e05c7979147f1b0ba5c15.png][]

## **HTTP请求方式** ##

对于资源的具体操作类型，由HTTP动词表示。

常用的HTTP动词有下面四个（括号里是对应的SQL命令）。

*  **GET（SELECT）**：从服务器取出资源（一项或多项）。

*  **POST（CREATE）**：在服务器新建一个资源。

*  **PUT（UPDATE）**：在服务器更新资源（客户端提供改变后的完整资源）。

*  **DELETE（DELETE）**：从服务器删除资源。

下面是一些例子。

1）GET /product：列出所有商品

2）POST /product：新建一个商品

3）GET /product/ID：获取某个指定商品的信息

4）PUT /product/ID：更新某个指定商品的信息

5）DELETE /product/ID：删除某个商品

6）GET /product/ID/purchase ：列出某个指定商品的所有投资者

7）get /product/ID/purchase/ID：获取某个指定商品的指定投资者信息

## **过滤信息** ##

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

下面是一些常见的参数。

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

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

3）?page=2&per\_page=100：指定第几页，以及每页的记录数。

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

1.  ?producy\_type=1：指定筛选条件

## **返回数据** ##

只要api接口成功接到请求，就不能返回200以外的HTTP状态。

为了保障前后端的数据交互的顺畅，建议规范数据的返回，并采用固定的数据格式封装。

接口返回模板：

![effd1a1c86791279521e12dbcb2e8812.png][]

**status 接口的执行的状态**

**=0** 表示成功

**<0** 表示有异常

**Data 接口的主数据**

可以根据实际返回数组或JSON对象

**Msg 信息**

当status!=0 都应该有错误信息

## **非Restful Api的需求** ##

由于实际业务开展过程中，可能会出现各种的api不是简单的restful 规范能实现的，因此，需要有一些api突破restful规范原则。特别是移动互联网的api设计，更需要有一些特定的api来优化数据请求的交互。

### **页面级的api** ###

把当前页面中需要用到的所有数据通过一个接口一次性返回全部数据

举例

api/v1/get-home-data 返回首页用到的所有数据

这类API有一个非常不好的地址，只要业务需求变动，这个api就需要跟着变更。

### **自定义组合api** ###

把当前用户需要在第一时间内容加载的多个接口合并成一个请求发送到服务端，服务端根据请求内容，一次性把所有数据合并返回,相比于页面级api，具备更高的灵活性，同时又能很容易的实现页面级的api功能。

**规范**

地址：api/v1/batApi

传入参数：

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:160px;vertical-align:bottom;height:52px;">名称</td> 
 <td style="width:80px;vertical-align:bottom;height:52px;">类型</td> 
 <td style="width:160px;vertical-align:bottom;height:52px;">必须</td> 
 <td style="width:321px;vertical-align:bottom;height:52px;">描述</td> 
 </tr> 
 <tr> 
 <td style="width:160px;vertical-align:top;height:52px;">key</td> 
 <td style="width:80px;vertical-align:top;height:52px;">String</td> 
 <td style="width:160px;vertical-align:top;height:52px;">是</td> 
 <td style="width:321px;vertical-align:top;height:52px;">调用key（<a style="color:#0A6CFF;" href="https://o0b.cn/jennif" rel="nofollow">获取API测试key</a>）</td> 
 </tr> 
 <tr> 
 <td style="width:160px;vertical-align:top;height:52px;">secret</td> 
 <td style="width:80px;vertical-align:top;height:52px;">String</td> 
 <td style="width:160px;vertical-align:top;height:52px;">是</td> 
 <td style="width:321px;vertical-align:top;height:52px;">调用密钥</td> 
 </tr> 
 <tr> 
 <td style="width:160px;vertical-align:top;height:52px;">api_name</td> 
 <td style="width:80px;vertical-align:top;height:52px;">String</td> 
 <td style="width:160px;vertical-align:top;height:52px;">是</td> 
 <td style="width:321px;vertical-align:top;height:52px;">API接口名称（包括在请求地址中）[item_search,item_get,item_search_shop等]</td> 
 </tr> 
 <tr> 
 <td style="width:160px;vertical-align:top;height:52px;">cache</td> 
 <td style="width:80px;vertical-align:top;height:52px;">String</td> 
 <td style="width:160px;vertical-align:top;height:52px;">否</td> 
 <td style="width:321px;vertical-align:top;height:52px;">[yes,no]默认yes，将调用缓存的数据，速度比较快</td> 
 </tr> 
 <tr> 
 <td style="width:160px;vertical-align:top;height:52px;">result_type</td> 
 <td style="width:80px;vertical-align:top;height:52px;">String</td> 
 <td style="width:160px;vertical-align:top;height:52px;">否</td> 
 <td style="width:321px;vertical-align:top;height:52px;">[json,jsonu,xml,serialize,var_export]返回数据格式，默认为json，jsonu输出的内容中文可以直接阅读</td> 
 </tr> 
 <tr> 
 <td style="width:160px;vertical-align:top;height:52px;">lang</td> 
 <td style="width:80px;vertical-align:top;height:52px;">String</td> 
 <td style="width:160px;vertical-align:top;height:52px;">否</td> 
 <td style="width:321px;vertical-align:top;height:52px;">[cn,en,ru]翻译语言，默认cn简体中文</td> 
 </tr> 
 <tr> 
 <td style="width:160px;vertical-align:top;height:52px;">version</td> 
 <td style="width:80px;vertical-align:top;height:52px;">String</td> 
 <td style="width:160px;vertical-align:top;height:52px;">否</td> 
 <td style="width:321px;vertical-align:top;height:52px;">API版本</td> 
 </tr> 
 </tbody> 
</table>

[e1275580b2f84510fb655e5e4694cfaf.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/0f04377111ea483c9f55b329933adb91.png
[be40d84757d68f20c045e6db3f5d2b70.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/1a73655e4deb453baf05aecc340dff5f.png
[c1ad25a4d98aefc43e8a72baf629ac2f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/b0bdc12d2d634a22b783597e8468c452.png
[ae280bf6439e05c7979147f1b0ba5c15.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/f2ce7f69f8a04828a6550b3b26777ea5.png
[effd1a1c86791279521e12dbcb2e8812.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/f1d726c761c54b1fa498dbcd35338f61.png