技术标签: 小白接口
你只需编写简单的云函数,就可以实现自己的业务逻辑,发布后就可以生成自己的接口给客户端调用。
果创云支持对云函数进行在线接口编程,进入开放平台我的接口 - 在线接口编程,设计一个新接口,设计和配置好接口参数、接口名称、接口返回后,再把云函数源代码填上,提交审核通过并发布后即可使用。
云函数编写入口:在线接口编程。
云函数具有以下特点和优势:
云函数由开发者自己编写,发布后可生成自己的云接口,即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;
}
更多示例,即将到来!
文章浏览阅读1k次。通过使用ajax方法跨域请求是浏览器所不允许的,浏览器出于安全考虑是禁止的。警告信息如下:不过jQuery对跨域问题也有解决方案,使用jsonp的方式解决,方法如下:$.ajax({ async:false, url: 'http://www.mysite.com/demo.do', // 跨域URL ty..._nginx不停的xhr
文章浏览阅读2k次。关于在 Oracle 中配置 extproc 以访问 ST_Geometry,也就是我们所说的 使用空间SQL 的方法,官方文档链接如下。http://desktop.arcgis.com/zh-cn/arcmap/latest/manage-data/gdbs-in-oracle/configure-oracle-extproc.htm其实简单总结一下,主要就分为以下几个步骤。..._extproc
文章浏览阅读1.5w次。linux下没有上面的两个函数,需要使用函数 mbstowcs和wcstombsmbstowcs将多字节编码转换为宽字节编码wcstombs将宽字节编码转换为多字节编码这两个函数,转换过程中受到系统编码类型的影响,需要通过设置来设定转换前和转换后的编码类型。通过函数setlocale进行系统编码的设置。linux下输入命名locale -a查看系统支持的编码_linux c++ gbk->utf8
文章浏览阅读750次。今天准备从生产库向测试库进行数据导入,结果在imp导入的时候遇到“ IMP-00009:导出文件异常结束” 错误,google一下,发现可能有如下原因导致imp的数据太大,没有写buffer和commit两个数据库字符集不同从低版本exp的dmp文件,向高版本imp导出的dmp文件出错传输dmp文件时,文件损坏解决办法:imp时指定..._imp-00009导出文件异常结束
文章浏览阅读143次。当下是一个大数据的时代,各个行业都离不开数据的支持。因此,网络爬虫就应运而生。网络爬虫当下最为火热的是Python,Python开发爬虫相对简单,而且功能库相当完善,力压众多开发语言。本次教程我们爬取前程无忧的招聘信息来分析Python程序员需要掌握那些编程技术。首先在谷歌浏览器打开前程无忧的首页,按F12打开浏览器的开发者工具。浏览器开发者工具是用于捕捉网站的请求信息,通过分析请求信息可以了解请..._初级python程序员能力要求
文章浏览阅读7.6k次,点赞2次,收藏6次。@Service标注的bean,类名:ABDemoService查看源码后发现,原来是经过一个特殊处理:当类的名字是以两个或以上的大写字母开头的话,bean的名字会与类名保持一致public class AnnotationBeanNameGenerator implements BeanNameGenerator { private static final String C..._@service beanname
文章浏览阅读6.9w次,点赞73次,收藏463次。1.前序创建#include<stdio.h>#include<string.h>#include<stdlib.h>#include<malloc.h>#include<iostream>#include<stack>#include<queue>using namespace std;typed_二叉树的建立
文章浏览阅读7.1k次。在Asp.net上使用Excel导出功能,如果文件名出现中文,便会以乱码视之。 解决方法: fileName = HttpUtility.UrlEncode(fileName, System.Text.Encoding.UTF8);_asp.net utf8 导出中文字符乱码
文章浏览阅读2.1k次,点赞4次,收藏23次。第一次实验 词法分析实验报告设计思想词法分析的主要任务是根据文法的词汇表以及对应约定的编码进行一定的识别,找出文件中所有的合法的单词,并给出一定的信息作为最后的结果,用于后续语法分析程序的使用;本实验针对 PL/0 语言 的文法、词汇表编写一个词法分析程序,对于每个单词根据词汇表输出: (单词种类, 单词的值) 二元对。词汇表:种别编码单词符号助记符0beginb..._对pl/0作以下修改扩充。增加单词
文章浏览阅读773次。我在使用adb.exe时遇到了麻烦.我想使用与bash相同的adb.exe shell提示符,所以我决定更改默认的bash二进制文件(当然二进制文件是交叉编译的,一切都很完美)更改bash二进制文件遵循以下顺序> adb remount> adb push bash / system / bin /> adb shell> cd / system / bin> chm..._adb shell mv 权限
文章浏览阅读6.8k次,点赞12次,收藏125次。1. 单目相机标定引言相机标定已经研究多年,标定的算法可以分为基于摄影测量的标定和自标定。其中,应用最为广泛的还是张正友标定法。这是一种简单灵活、高鲁棒性、低成本的相机标定算法。仅需要一台相机和一块平面标定板构建相机标定系统,在标定过程中,相机拍摄多个角度下(至少两个角度,推荐10~20个角度)的标定板图像(相机和标定板都可以移动),即可对相机的内外参数进行标定。下面介绍张氏标定法(以下也这么称呼)的原理。原理相机模型和单应矩阵相机标定,就是对相机的内外参数进行计算的过程,从而得到物体到图像的投影_相机-投影仪标定
文章浏览阅读2.2k次。文章目录Wayland 架构Wayland 渲染Wayland的 硬件支持简 述: 翻译一篇关于和 wayland 有关的技术文章, 其英文标题为Wayland Architecture .Wayland 架构若是想要更好的理解 Wayland 架构及其与 X (X11 or X Window System) 结构;一种很好的方法是将事件从输入设备就开始跟踪, 查看期间所有的屏幕上出现的变化。这就是我们现在对 X 的理解。 内核是从一个输入设备中获取一个事件,并通过 evdev 输入_wayland