会SQL，就能开放你的数据API接口

如果你是非技术开发工程，不熟悉Java、PHP、Python、Golang这些后端的编程语言，但熟悉MySQL、Oracle、SQL Server、PostgreSQL这些数据库的查询操作，当你需要把现有的数据库的数据，通过API接口形式提供给外部人员使用时，使用派框架·接口大师这个工具，就能轻松实现。

低代码接口开发工具

派框架·接口大师，是一套研发、管理和开放API接口的软件源代码和解决方案，基于PhalApi开源接口框架+Vue前后端分离，可用于快速搭建各类企业级接口平台。

适合用于开发新项目、已使用PhalApi开源框架的项目，或现有项目的系统重构，可用于快速搭建：OpenAPI、接口平台、数据平台、PaaS平台、SaaS平台、BaaS平台、开放平台等。

本地安装好后，就可以开始使用了。

具体的数据接口示例教程

假设我们已经在以下的国家数据库表pp_countries：

字段 sortname：表示国家简称，name 表示国家全称，还有区号phonecode，以及经纬度字段。

现在使用 接口大师 这个工具，介绍如何低代码开发、管理和开放你的数据API接口。

自动生成数据API接口

进入接口大师的管理后台，进入接口管理-低代码接口开发-添加接口。

接口设计类型选择：生成数据库表接口API。

在接口服务名称这里，把类名改成你的数据库表名，不需要带表前缀，同时使用大写开头的坨峰法写法。

在接口参数填写需要支持的搜索参数。

例如，支持国家名称的模糊匹配。

接下来，点击生成代码。会生成类似如下的PHP代码：

<?php
namespace App\Api;
use App\Common\DataApi as Api;
// use App\Domain\Countries as CountriesDomain;

/**
 * 国家地区
 */
class Countries extends Api {

    /**
     * 接口参数规则配置
     */
    public function getRules() {
        $rules = parent::getRules();
        $curRules = array(
            'ActionName' => array(
                
                'name' => array (
                'name' => 'name',
                'type' => 'string',
                'desc' => '国家名，模糊匹配',
                'require' => true,
              ),

            ),
        );
        return array_merge($rules, $curRules);
    }

    /**
     * 查询搜索国家地区列表
     * @desc 请输入接口功能描述
     * 
     */ 
    public function ActionName() {
        // 接口参数获取
        $name = $this->name; // 国家名，模糊匹配接口参数
        
        // 结果返回
        $rs = array(); 

        // 获取用户ID，未登录时异常返回
        // $uid = $this->tryToGetUid();

        // 获取app_key，未指定时异常返回
        // $appKey = $this->tryToGetAppKey();

        // TODO: 实现你的业务逻辑……
        // $domain = new CountriesDomain();

        // 动态查询参数
        $whereParams = array(
            ':name' => $name, // 国家名，模糊匹配
        );

        // 获取数据库的表实例，可以切换你的数据库和其他表
        $table = \PhalApi\DI()->notorm->countries;
        
        // 根据SQL查询数据库，需要带表前缀
        // 更多数据库操作请见：http://docs.phalapi.net/#/v2.0/database-usage
        $sql = 'SELECT * FROM pp_countries WHERE name = :name LIMIT 0, 100';
        $rows = $table->queryAll($sql, $whereParams);
        
        // 对数据的加工处理
        foreach ($rows as &$itRef) {
            // 对每一行数据的处理……
            // $itRef['id'] = $itRef['id'];
        }

        // 返回数据
        $rs['rows'] = $rows;
            

        return $rs;

    }

    // 绑定数据库模型
    protected function getDataModel() {
        return new \App\Model\Countries();
    }
}

生成的代码，可以不用太关注。你只需要调整SQL语句，改成自己需要搜索的条件即可。

例如，找到SQL这一行的语句：

        // 根据SQL查询数据库，需要带表前缀
        // 更多数据库操作请见：http://docs.phalapi.net/#/v2.0/database-usage
        $sql = 'SELECT * FROM pp_countries WHERE name = :name LIMIT 0, 100';

改成你自己的SQL语句，例如模糊搜索国家名。

        // 根据SQL查询数据库，需要带表前缀
        // 更多数据库操作请见：http://docs.phalapi.net/#/v2.0/database-usage
        $sql = 'SELECT * FROM pp_countries WHERE name LIKE :name LIMIT 0, 100';

同时把参数调整成左右模糊匹配：

        // 动态查询参数
        $whereParams = array(
            ':name' => '%'.$name.'%', // 国家名，模糊匹配
        );

然后，点击【保存并发布】。

数据接口的在线接口文档、在线测试和调试

发布接口后，就可以在OpenAPI在线接口文档看到刚刚添加发布的新数据接口。

点击可以进入新接口的在线接口文档。截图如下：

你可以在线进行接口测试。填入需要搜索的国家名，例如：输入A。

可以看到接口返回以下数据：

{
    "ret": 200,
    "data": {
        "rows": [
            {
                "id": 1,
                "sortname": "AF",
                "name": "Afghanistan",
                "phonecode": 93,
                "lat": "33.93911",
                "lng": "67.709953"
            },
            {
                "id": 2,
                "sortname": "AL",
                "name": "Albania",
                "phonecode": 355,
                "lat": "41.153332",
                "lng": "20.168331"
            },
            .......
        ]
    },
    "msg": ""
}

开启调试模式后，还可以看到背后执行的SQL语句和执行时间：

[#2 - 4.7ms - SQL]/path/to/src/app/Api/Countries.php(63):    App\\Api\\Countries::ActionName()    pp_countries    SELECT * FROM pp_countries WHERE name LIKE :name LIMIT 0, 100; -- '%A%'

完善接口文档

你还可以补充添加接口返回的结构、字段说明。

再次发布后，就可以在前台接口文档查看到：

开放你的数据接口API

最后，再来看下如何把你开发添加好的新数据接口API开放给其他人。

开发者的主要使用流程是：

所以，开发者，需要先到开放平台注册一个新账号，然后登录。

再创建新的应用并等待后台审核通过：

应用通过审核后，根据app_key和密钥，申请接口访问令牌。

获取到访问令牌access_token后，就可以调用和使用你新添加的数据API接口。