百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术资源 > 正文

会SQL语句,就能快速开放你的数据接口API

moboyou 2025-03-11 14:35 32 浏览

会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代码:

 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接口。

相关推荐

记一次前端逻辑绕过登录到内网挖掘

前言在测试一个学校网站的时候发现一个未授权访问内网系统,但是这个未授权并不是接口啥的,而是对前端js的审计和调试发现的漏洞,这里给大家分享一下这次的漏洞的过程文章中涉及的敏感信息均已做打码处理,文...

陕西普通话等级查询网的开发者被指将考生数据直接写入源码里

据报道,陕西普通话等级查询网站突然引起大量程序员关注。有人晒出该网站的源代码的打码截图,图中显示,所有考生数据都被直接写在该网站的源代码里。这表示任何人不需要经过任何验证直接查看源代码即可访问考生信息...

PHP8知识详解:PHP是什么?

PHP是什么?PHP服务网从下面几点为你讲清楚什么是PHP。1、PHP最开始是PersonalHomePage(个人主页)的缩写,已经正式更名为“PHP:HypertextPreproces...

PHP紧急更新修复漏洞:自5.x以来所有版本均受影响

IT之家6月8日消息,PHP项目维护团队昨日发布新补丁,修复了存在于PHPforWindows中的远程代码执行(RCE)漏洞,并敦促用户尽快更新至6月6日发布的8.3.8、...

OA协同办公系统源码解析

在如今的信息化时代,PHPOA软件承当着为企事业单位提供安全、稳定、开源的信息化安全系统,在当今信息化时代,协同办公系统成为了企业管理的重要工具。OA(OfficeAutomation)协同办公系统...

附源码:PHP实现查询汉字笔画、笔画排序

有时候我们在开发中可能会用到和汉字有关的方法,例如笔画排序之类的,但是直接进行sort排序往往得不到我们想要的结果,因为内部并没有预留这些排序方法。因此我们需要自己动手,今天就教大家实现汉字笔画的...

StrongShop跨境电商系统源码 | 支持多语言多货币

StrongShop跨境电商系统源码|支持多语言多货币StrongShop是一款免费开源的跨境电商商城网站。基于PHPLaravel框架开发的一款Web商城系统。该项目在没有对Lar...

源代码的定义

源代码是程序员在开发程序时(通常是在字处理程序中)编写的人类可读指令的列表。源代码通过编译器将其转换为机器代码,也称为目标代码,计算机可以理解和执行。目标代码主要由1和0组成,所以它是不可读的。源代码...

2077年了,PHP语言现在怎么样啦?

“PHP是世界上最好的语言!”这句话一出来,编程界的鄙视链一触即发,程序员的键盘世界大战就爆发了。那么,本文就简单讨论PHP语言,笔者作为创业小公司小团队的角度来妄议一下PHP。首先直接说明观点:新手...

开源直播系统源码—为什么要使用PHP语言

开展开源直播系统源码的的开发工作的时候,开发人员们碰到的最多问题便是使用什么语言开发的,回答大多是PHP语言。而对于没有的开发经验的人而言,难以理解PHP语言究竟代表着什么,又有哪些作用。实际上,PH...

手游平台源码搭建使用的PHP是什么?有什么优点吗?

PHP即“超文本预处理器”,是在服务器端执行的脚本语言,尤其适用于Web开发并可嵌入html中。PHP结合了C语言、java和perl多个语言的特色发展出自己的特色语法,并依据它们的长项持续改进提升自...

PHP直播源码,直播系统源代码功能有哪些?

PHP直播源码究竟是什么?其实所谓的PHP直播源码就是用PHP语言开发的直播系统源代码。PHP是什么?PHP原始为PersonalHomePage的缩写,已经正式更名为“PHP:Hyperte...

盘点如何利用PHP生成PDF文件

在PHP代码中生成PDF文件是一项非常耗时的工作,早期的程序员通常是在PHP代码中利用FPDF生成PDF文件。但在如今,有很多的函数库可以使用,借助它们你可以从你提供的HTML文档生成PDF文件,从而...

PHP低代码开发平台 V5.0.7新版发布

注意:本版变更:此版本增加租户内测模式,同时增加软删除及数据回收功能。Sfdp更新6.0.5版本Tpflow更新6.0.7版本1.[修复]修复数据为空的时桌面方案报错修复了在桌面组件删除时,由于用户...

「sabre/dav」只要十行代码让你的网站获得WebDav网盘能力

如今网盘已经成为我们日常中很重要的工具了,不仅仅可以和别人分享,更重要的是可以在我们不同的设备之间读取资料.那什么是WebDav呢?WebDav是一个Http上封装的一个文件系统,就像ftp,nfs之...