技术标签: 小白接口
你只需编写简单的云函数,就可以实现自己的业务逻辑,发布后就可以生成自己的接口给客户端调用。
果创云支持对云函数进行在线接口编程,进入开放平台我的接口 - 在线接口编程,设计一个新接口,设计和配置好接口参数、接口名称、接口返回后,再把云函数源代码填上,提交审核通过并发布后即可使用。
云函数编写入口:在线接口编程。
云函数具有以下特点和优势:
云函数由开发者自己编写,发布后可生成自己的云接口,即MyAPI,而云函数底层则依赖于果创云提供的基础服务。
因此,云函数整体架构如下:
整体架构分为四层:
第一层:MyAPI我的接口 提供给客户端调用的云接口。
第二层:云函数。 由开发者自己编写,可在线接口编程,编写云函数,生成接口。
第三层:果创云聚合服务 由果创云提供,封装了常用的服务,可进行数据库、CURL、短信等服务操作。
第四层:云服务 由第三方提供的云服务,包括但不限于自建数据库、云数据库、企业邮箱、短信接口、开放平台接口和内部接口等。
当前只支持PHP云函数,开发者自定义的云函数,需要符合PHP语法。其云函数签名和云函数模板如下:
function ($params, $di) {
$result = array('err_code' => 0, 'err_msg' => '');
// TODO
// 在这里编写你的具体业务
return $result;
}
云函数参数说明:
$params
,类型:数组,为当前客户端的接口参数,由开发者配置的接口参数和客户端动态传递的参数而定,例如:array('uuid' => null, 'left' => 1, 'right' => 2)
$di
,类型:数组,为DI容器,里面封装并提供了众多强大而实用的PHP服务,例如数据库操作等,对于后端编程有非常大的帮助,后面会详细介绍。如何获取客户端传递过来的接口参数?
在果创云开放接口参数配置,添加参数后,就可以在源代码中获取。如下:
假设,配置的接口参数名字为:abc,那么在PHP源代码中,获取接口参数的方式是从$params
参数中获取,如:
$abc = $params['abc'];
参数名称和配置的接口名称一致。并且,此时获取的接口参数会根据配置的接口参数规则进行过滤、转换和检测。
温馨提示:接口会自动对客户端的参数进行校验、核对和转换,通过
$params
参数获取的是最终可用的参数。
开头不需要<?php
标签,结束不需要?>
标签。你可以在本地调试好PHP代码函数,或者通过在线工具编写和运行你的PHP代码。
特别注意以下几点:
如何进行本地调试? 在本地调试时,可以这样执行你的PHP代码。
首先,创建一个PHP文件,例如:yesapi.php,然后在里面放置代码:
<?php
$fun = function ($params, $di) {
// 函数内的代码复制过来
$result = array('err_code' => 0, 'err_msg' => '');
$result['sum'] = $params['left'] + $params['right'];
return $result;
};
// 模拟一些测试数据
$params = array('left' => 1, 'right' => 2);
// 执行函数,输出结果
var_dump($fun($params, array()));
// 输出结果 1+2=3
array(3) {
["err_code"]=>
int(0)
["err_msg"]=>
string(0) ""
["sum"]=>
int(3)
}
即这样执行,通过CLI方式运行。
$ php ~/tmp/test.php
array(3) {
["err_code"]=>
int(0)
["err_msg"]=>
string(0) ""
["sum"]=>
int(3)
}
温馨提示:在本地没有
$di
服务,可以使用空数组来代替,或进行模拟测试。
如何返回接口结果呢?
以下是一个返回示例:
return array('err_code' => 0, 'err_msg' => '', 'title' => 'Hi, 欢迎使用果创云开放接口!');
注意,应该在函数的最后一行代码通过return关键字返回结果。结果的类型是数组,且应包括:err_code、err_msg这两个基本字段,以及其他需要自定义的返回字段。
其中,约定err_code为0表示成功。
以下是一个简单的例子,进行两个数的相加。
function ($params, $di) {
$result = array('err_code' => 0, 'err_msg' => '');
$result['sum'] = $params['left'] + $params['right'];
return $result;
}
添加一个新接口,并进行编辑:
编写接口时,设置接口参数、接口返回、云函数代码等,如(局部截图):
保存后,你可以看到类似这样的在线接口文档(部分截图):
在完成接口设计和云函数开发后,就可以勾选“申请发布”。等审核通过后即可发布和使用。
。
发布通过后,你就可以生成了自己的云接口,以及在线接口文档。
在线接口文档,可以提供给客户端开发人员查看和接入使用;云接口可以提供给客户端进行调用。
生成的完整在线接口文档类似:
接口文档地址:
http://api.yesapi.cn/docs.php?service=SVIP.Sdogstar_MyApi.ATest&detail=1&type=fold
客户端调用后,就可以得到云函数执行后的结果。
编写好云函数后,会自动生成云接口,和接口文档。如果需要,也可以自己手动编写接口文档。
温馨提示:如果需要手动编写API接口文档,可以进入我的在线文档编辑,保存后可发布接口文档。
文档编辑后台:
保存后,外部查看的接口文档效果:
如果需要支持多个客户端调用API接口,可以【客户端管理】,添加客户端应用,然后分配app_key和密钥。
以下通过代码示例和模板,介绍云函数如何进行开发,大家可以把代码复制过去,稍作修改。
只需要简短的几行PHP代码,或者一段代码,你就实现自己的业务逻辑,无需管理服务器即可运行移动后端代码。
在开始,以下是一些重要的知识点和注意事项。
$di['db']->模型英文名称_tbl
,例如文章模型:$di['db']->article_tbl
,后面要固定加上_tbl
;$di['db_super']->数据库表完整名称
,例如:$di['db_super']->article
;使用前请配置接入你的数据库。再重复说明下,直连数据库和我的模型数据库操作一样,区别在于:直连数据库在使用前需要先配置接入你的数据库,DI服务使用$di['db_super']
,最后需要填写完整的表名称,不需要额外的_tbl
后缀。
DI服务 | 功能说明 | 备注 |
---|---|---|
$di['db'] | 我的模型数据库 | 可进行CURD数据库操作,针对单表 |
$di['db_super'] | 直连数据库 | 可进行CURD数据库操作,针对单表,使用前需要进行MySQL数据库直连服务配置 |
$di['logger'] | 日志服务 | 纪录各种日志 |
$di['email'] | 邮箱服务 | 发送邮件,使用前需要进行邮箱服务配置 |
$di['pinyin'] | 拼音服务 | 将汉字转成拼音 |
$di['curl'] | CURL服务 | 请求远程接口,仅支持80端口 |
$di['crypt'] | 安全服务 | 对数据进行加密和解密 |
$di['sms_aliyun'] | 阿里云短信 | 通过阿里云服务发送短信,使用前需要进行阿里云服务配置 |
function ($params, $di) {
$result = array('err_code' => 0, 'err_msg' => '');
$result['sum'] = $params['left'] + $params['right'];
return $result;
}
假设传递参数为:left=1&right=2
,请求此云函数后,将会得到如下结果:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"sum": 3
},
"msg": "V2.1.1 YesApi"
}
function ($params, $di) {
$result = array('err_code' => 0, 'err_msg' => '');
$result['count'] = $di['db']->article_tbl->count('id'); // 模型名称后面须带上_tbl后缀
return $result;
}
假设你有模型如下,有23条数据:
请求此云函数后,将会得到如下结果:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"count": 23
},
"msg": "V2.1.1 YesApi"
}
function ($params, $di) {
$result = array('err_code' => 0, 'err_msg' => '');
$article = $di['db']->article_tbl;
$article->insert($data);
$result['id'] = $article->insert_id(); // 返回新增的ID
return $result;
}
function ($params, $di) {
$result = array('err_code' => 0, 'err_msg' => '');
$result['article'] = $di['db']->article_tbl->where('id', 1)->fetchOne(); // 取出id=1的文章数据
return $result;
}
function ($params, $di) {
$result = array('err_code' => 0, 'err_msg' => '');
$data = array('title' => '新文章标题', 'content' => '文章内容'); // 待更新的数据
$result['update_row'] = \$di['db']->article_tbl->where('id', 1)->update($data); // 更新id=1的文章数据,返回更新的数量
return $result;
}
function ($params, $di) {
$result = array('err_code' => 0, 'err_msg' => '');
$result['delete_row'] = $di['db']->article_tbl->where('id', 1)->delete(); // 删除数据,返回删除的数量
return $result;
}
function ($params, $di) {
$result = array('err_code' => 0, 'err_msg' => '');
$result['list'] = $di['db']->article_tbl->where('id > ?', 1)->where('id < ?', 10)->fetchAll(); // 取出id从1到10的全部数据
return $result;
}
function ($params, $di) {
$result = array('err_code' => 0, 'err_msg' => '');
$result['list'] = $di['db']->article_tbl
->select('id, title, content')
->where('id', 1) // 精确区配
->where('name LIKE ?', '%小白%') // 模糊匹配
->where('id', array(1, 2, 3)) // 范围枚举
->where('id > ?', 1) // 范围大于
->where('id < ?', 10) // 范围小于
->where('id BETWEEN ? AND ?', array(1, 10)) // 范围介于
->or('status', 1) // 或逻辑条件
->order('add_time DESC') // 按时间降序
->limit(0, 100) // 分页,取出前面100条
->fetchAll(); // 取全部数据
return $result;
}
温馨提示:获取列表数据时,一定要使用
limit
限制分页数量,否则会审核不通过。
function ($params, $di) {
$result = array('err_code' => 0, 'err_msg' => '');
// 第一个参数为网址,第二个参数表示超时时间(单位毫秒)
$result['res'] = $di['curl']->get('http://demo.phalapi.net/?username=YesApi', 3000);
// 得到结果类似:{"ret":200,"data":{"title":"Hello YesApi","version":"2.13.3","time":1590764249},"msg":""}
return $result;
}
function ($params, $di) {
$result = array('err_code' => 0, 'err_msg' => '');
// 第一个参数为网址,第二个参数是POST的参数,第三个参数表示超时时间(单位毫秒)
$result['res'] = $di['curl']->post('http://demo.phalapi.net/', array('username' => 'YesApi'), 3000);
// 得到结果类似:{"ret":200,"data":{"title":"Hello YesApi","version":"2.13.3","time":1590764249},"msg":""}
return $result;
}
温馨提示:通过云函数以及CURL,可以对原有的API接口进行封装,形成对外开放的接口API。
function ($params, $di) {
$result = array('err_code' => 0, 'err_msg' => '');
$di['logger']->record('DEBUG', '调试日志,这里可放日志内容');
$di['logger']->record('INFO', '业务日志,这里可放日志内容');
$di['logger']->record('INFO', array('uuid' => 'ABC', 'tip' => '第二个参数还可以是数组'));
$di['logger']->record('NOTICE', '提醒日志,这里可放日志内容');
$di['logger']->record('WARNNING', '警告日志,这里可放日志内容');
$di['logger']->record('ERROR', '错误日志,这里可放日志内容');
return $result;
}
温馨提示:日志纪录后,可以到开放平台查看日志。
function ($params, $di) {
$result = array('err_code' => 0, 'err_msg' => '');
// 第一个参数是收件人邮箱,第二个参数是邮件标题,第三个参数是邮件正文内容(HTML格式)
$result['is_send'] = $di['email']->send('[email protected]', '邮件标题', '邮件内容');
return $result;
}
温馨提示:使用前请先配置邮箱服务配置。
function ($params, $di) {
$result = array('err_code' => 0, 'err_msg' => '');
$result['encrypt_data'] = $di['crypt']->encrypt('YesApi'); // 对数据进行加密
$result['decrypt_data'] = $di['crypt']->decrypt($result['encrypt_data']); // 对数据进行解密
return $result;
}
温馨提示:每个app_key加密的数据,只能由自己的app_key进行解密。
function ($params, $di) {
$result = array('err_code' => 0, 'err_msg' => '');
$result['pinyin_1'] = $di['pinyin']->convert('小白接口'); // 将一段汉字串内容转成拼音,结果是:xiao bai jie kou
$result['pinyin_2'] = $di['pinyin']->abbr('小白接口'); // 获取拼音首字母,结果是:x b j k
$result['pinyin_3'] = $di['pinyin']->name('张三'); // 姓名转拼音,结果是:zhang san
return $result;
}
function ($params, $di) {
$result = array('err_code' => 0, 'err_msg' => '');
// 参数1:手机号,参数2:短信签名,参数3:短信模板,参数3:更多数组参数(没动态参数时可传空数组)
$di['sms_aliyun']->aliyunSendSms('13800138000', '小白接口', 'SMS_153055065', array('code' => '123456'));
return $result;
}
温馨提示:使用前需要进行阿里云服务配置
function ($params, $di) {
$result = array('err_code' => 0, 'err_msg' => '');
$time = time(); // 当前时间戳,例如:1590561632
$datetime = date('Y-m-d H:i:s'); // 当前时间,例如:2020-05-20 00:00:00
$arr = json_decode('{"name":"YesApi"}', true); // json解析成数组
$json = json_encode($arr); // 数组转json
$md5 = md5('123456'); // md5操作
return $result;
}
更多示例,即将到来!
文章浏览阅读2.3k次。1、挂在光驱,原始的centos镜像2、按F11或者其他提示的按键进入修复模式3、使用以下的命令进行修复;_centos系统linux 重启后lvm未激活
文章浏览阅读2.6k次。Qt5利用QProcess执行cmd命令把文件从一个目录移动到另一个目录,即执行cmd里的copy命令:copy 原文件 目标位置代码需要在头文件中加入 #include<QProcess>void MainWindow::on_ptn_clicked(){ QProcess p(0); //这个会报错 p.start("copy C:\\Users\..._qt qprocess使用cmd切换目录
文章浏览阅读573次。转载公众号 | 知识管理就在夏博自从ChatGPT成功推出以来,像大型语言模型LLM这样的人工智能系统引起了全球的关注,尽管LLM存在的时间要长得多。这些系统现在支持从聊天机器人、内容生成到头脑风暴和脚本代码的很多场景。然而,随着这些模型变得越来越复杂,它们产生错误的可能性也越来越大。最近,像ChatGPT这样的大型语言模型产生了不准确的报告,争论了不正确的事实,并在他们的答案中描述了现实世界的偏..._知识图谱chatgpy幻觉
文章浏览阅读549次,点赞17次,收藏11次。分支-条件覆盖可以使程序中的判断语句以及判断语句中的条件的真、假分支都得到覆盖,但是分支-条件覆盖达到 100% 仍然强度不够,程序中的某些逻辑运算等错误仍然可能不会被发现。_白盒测试测试中的分支测试
文章浏览阅读172次。PHP版本也是一样的 都是7.4。就很迷惑 一模一样的代码 怎么上线就会报错。但是又不能不用 因为两个表有相同的字段 去掉别名更是报错。奇怪的是 线下环境大写小写都可以用 不报错。最终解决手段:别名首字母改小写就好了。线上环境只能小写 大写就报错了。代码上线之后莫名报错。_fastadmin关联搜索 出错
文章浏览阅读6.7k次,点赞2次,收藏2次。1. 通用格式1.1 安装依赖1.1 命令yum install xx -y1.2 解压缩源码包1.2.1 命令wget xxxxtar -xf xx.tar.xz1.3 configure 编译且安装( 进入python源码包目录,编译且安装 )1.3.1 命令./configure --prefix=安装路径1.3.2 介绍./configure --prefix=/opt/python365/ 上面的意思是将该软件安装在 /usr 下面,执._编译安装python3.6
文章浏览阅读62次。Sql2005 全文索引详解1.前言14.1 全文索引的介绍14.2 全文索引中常用的术语14.3 全文索引的体系结构14.4 全文目录管理14.4.1 创建全文目录14.4.2 查看与修改全文目录14.4.3 删除全文目录14.5 全文索引管理14.5.1 创建全文索引的注意事项14.5.2 创建全文索引14.5.3..._sqlsever全文索引断字符中文选择那个
文章浏览阅读7.3k次。背景:在进行SQL语句编写时,我们经常会遇到大量的同时进行Insert/Update的语句 ,也就是说当存在记录时,就更新(Update),不存在数据时,就插入(Insert)。比如现在有张J_USER这张表,T_USER表用 J 表 的数据 来更新 T 表的数据MERGE INTO t_user t using (select * from j_user j) b on ..._merge into t_b_info_bb b
文章浏览阅读141次。Metro(米雀)是微软在Windows Phone中正式引入的一种界面设计语言,也是Windows 8的主要界面显示风格。在Windows Phone之前,微软已经在Zune Player和XBox 360主机中尝试采用过类似的界面风格,并得到了用户的广泛认可。于是,微软在新发布的Windows Phone、已经发布的Windows 8预览版以及Office 15中也采用了Metro设计,今后的..._html metro
文章浏览阅读1k次,点赞6次,收藏17次。自然语言处理综合应用系统文章目录前言一、自然语言处理是什么?二、自然语言处理的内容三、自然语言处理综合应用系统1.自然语言处理包2.项目结构3.功能实现总结前言研究生自然语言处理课程的大作业,不想写综述文章,就做了个系统自然语言处理综合应用系统,功能包括句法分析、文本分词、相似度检测、语义相似度检测、命名实体识别、语义角色标注、文本总结、简繁转换和词云。提示:以下是本篇文章正文内容,下面案例可供参考一、自然语言处理是什么?自然语言处理( Natural Language Process_大型系统 自然语言集中处理
文章浏览阅读1.5k次,点赞6次,收藏8次。1、题目:问题描述:在某操作系统中打开了 N 个窗口,每个窗口都是一个矩形区域。窗口之间有层次的区别,在多于一个窗口重叠的区域里,只会显示位于顶层的窗口里的内容。当你点击屏幕上一个点的时候,你就选择了处于被点击位置的最顶层窗口,并且这个窗口就会被移到所有窗口的最顶层,而剩余的窗口的层次顺序不变。如果你点击的位置不属于任何窗口,则系统会忽略你这次点击。现在我们希望你写一个程序模拟点击窗口的过程算法思想:由于在某一次点开的网页所在的层数我们是不知道的,因此这道题并不方便采用栈或者队列,由于这里涉及到了较_在某操作系统中打开了 n 个窗口,每个窗口都是一个矩形区域。窗口之间有层次的区别
文章浏览阅读1.9w次,点赞4次,收藏9次。玩转树莓派-Raspberry,无线网配置方法_树莓派设置wpa无线网络和有限网络的优先级