基于Laravel的API服务端架构代码

谁借莪１个温暖的怀抱￠ 2021-07-16 13:13 332阅读 0赞

# API服务端架构代码 #

## 源码 ##

[http://flc.ren/2016/08/549.html][http_flc.ren_2016_08_549.html]  
[https://github.com/flc1125/Ap...][https_github.com_flc1125_Ap...]

## 部署说明 ##

> 现有API基于laravel框架开发，本次介绍也针对laravel。可根据文档自行调整，以适用其他框架下使用

### 数据库相关 ###

执行如下SQL语句

CREATE TABLE `prefix_apps` ( `id` INT(10) NOT NULL AUTO_INCREMENT COMMENT '自增长', `app_id` VARCHAR(60) NOT NULL COMMENT 'appid', `app_secret` VARCHAR(100) NOT NULL COMMENT '密钥', `app_name` VARCHAR(200) NOT NULL COMMENT 'app名称', `app_desc` TEXT COMMENT '描述', `status` TINYINT(2) DEFAULT '0' COMMENT '生效状态', `created_at` INT(10) NOT NULL DEFAULT '0' COMMENT '创建时间', `updated_at` INT(10) NOT NULL DEFAULT '0' COMMENT '更新时间', PRIMARY KEY (`id`), UNIQUE KEY `app_id` (`app_id`), KEY `status` (`status`) ) ENGINE=INNODB DEFAULT CHARSET=utf8 COMMENT='应用表';

### 目录相关 ###

## API文档及开发规范 ##

### API调用协议 ###

#### 请求地址及请求方式 ####

> 请求地址：`/api/router`;
> 
> 请求方式：`POST`/`GET`

#### 公共参数 ####

<table style=""> 
 <thead style=""> 
  <tr style=""> 
   <th style="background:rgb(243,243,243); padding:5px 8px; border:1px solid rgb(230,230,230); text-align:left; word-break:normal"> 参数名</th> 
   <th style="background:rgb(243,243,243); padding:5px 8px; border:1px solid rgb(230,230,230); text-align:left; word-break:normal"> 类型</th> 
   <th style="background:rgb(243,243,243); padding:5px 8px; border:1px solid rgb(230,230,230); text-align:left; word-break:normal"> 是否必须</th> 
   <th style="background:rgb(243,243,243); padding:5px 8px; border:1px solid rgb(230,230,230); text-align:left; word-break:normal"> 描述</th> 
  </tr> 
 </thead> 
 <tbody style=""> 
  <tr style=""> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> app_id</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> string</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 是</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 应用ID</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> method</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> string</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 是</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 接口名称</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> format</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> string</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 否</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 回调格式，默认：json（目前仅支持）</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> sign_method</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> string</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 否</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 签名类型，默认：md5（目前仅支持）</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> nonce</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> string</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 是</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 随机字符串，长度1-32位任意字符</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> sign</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> string</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 是</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 签名字符串，参考<a style="background:none; outline:0px; color:rgb(0,154,97); text-decoration:none" rel="nofollow">签名规则</a></td> 
  </tr> 
 </tbody> 
</table>

#### 业务参数 ####

> API调用除了必须包含公共参数外，如果API本身有业务级的参数也必须传入，每个API的业务级参数请考API文档说明。

#### 签名规则 ####

*  对所有API请求参数（包括公共参数和请求参数，但除去`sign`参数），根据参数名称的ASCII码表的顺序排序。如：`foo=1, bar=2, foo_bar=3, foobar=4`排序后的顺序是`bar=2, foo=1, foo_bar=3, foobar=4`。
 *  将排序好的参数名和参数值拼装在一起，根据上面的示例得到的结果为：bar2foo1foo\_bar3foobar4。
 *  把拼装好的字符串采用utf-8编码，使用签名算法对编码后的字节流进行摘要。如果使用`MD5`算法，则需要在拼装的字符串前后加上app的`secret`后，再进行摘要，如：md5(secret+bar2foo1foo\_bar3foobar4+secret)
 *  将摘要得到的字节结果使用大写表示

#### 返回结果 ####

// 成功
    {
        "status": true,
        "code": "200",
        "msg": "成功",
        "data": { "time": "2016-08-02 12:07:09" } }
    
    // 失败
    {
        "status": false,
        "code": "1001",
        "msg": "[app_id]缺失" }

### API开发规范 ###

#### API接口命名规范（method） ####

*  接口名称统一小写字母
 *  多单词用`.`隔开
 *  对应的类文件（目录：`app/Services/ApiServer/Response/`）；以接口名去`.`，再首字母大写作为类名及文件名。如接口名：`user.add`，对应的类文件及类名为：`UserAdd`
 *  接口命名规范
    
     *  命名字母按功能或模块从大到小划分，依次编写；如后台用户修改密码：'admin.user.password.update'
     *  字母最后单词为操作。查询:`get`;新增:`add`;更新:`update`;删除:`delete`;上传:`upload`;等

#### 错误码 ####

> 错误码配置：`app/Services/ApiServer/Error.php`

命名规范：

现有错误码：

<table style=""> 
 <thead style=""> 
  <tr style=""> 
   <th style="background:rgb(243,243,243); padding:5px 8px; border:1px solid rgb(230,230,230); text-align:left; word-break:normal"> 错误码</th> 
   <th style="background:rgb(243,243,243); padding:5px 8px; border:1px solid rgb(230,230,230); text-align:left; word-break:normal"> 错误内容</th> 
  </tr> 
 </thead> 
 <tbody style=""> 
  <tr style=""> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 200</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 成功</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 400</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 未知错误</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 401</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 无此权限</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 500</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 服务器异常</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 1001</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> [app_id]缺失</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 1002</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> [app_id]不存在或无权限</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 1003</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> [method]缺失</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 1004</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> [format]错误</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 1005</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> [sign_method]错误</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 1006</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> [sign]缺失</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 1007</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> [sign]签名错误</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 1008</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> [method]方法不存在</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 1009</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> run方法不存在，请联系管理员</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 1010</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> [nonce]缺失</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 1011</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> [nonce]必须为字符串</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> 1012</td> 
   <td style="padding:5px 8px; border:1px solid rgb(230,230,230); word-break:normal"> [nonce]长度必须为1-32位</td> 
  </tr> 
 </tbody> 
</table>

#### API DEMO 示例 ####

文件路径：`app/Services/ApiServer/Response/Demo.php`

`转：https://segmentfault.com/a/1190000006178269`

[http_flc.ren_2016_08_549.html]: http://flc.ren/2016/08/549.html
[https_github.com_flc1125_Ap...]: https://github.com/flc1125/ApiServer