技术标签: 小白接口
你只需编写简单的云函数,就可以实现自己的业务逻辑,发布后就可以生成自己的接口给客户端调用。
果创云支持对云函数进行在线接口编程,进入开放平台我的接口 - 在线接口编程,设计一个新接口,设计和配置好接口参数、接口名称、接口返回后,再把云函数源代码填上,提交审核通过并发布后即可使用。
云函数编写入口:在线接口编程。
云函数具有以下特点和优势:
云函数由开发者自己编写,发布后可生成自己的云接口,即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;
}
更多示例,即将到来!
文章浏览阅读3.8k次,点赞9次,收藏28次。直接上一个工作中碰到的问题,另外一个系统开启多线程调用我这边的接口,然后我这边会开启多线程批量查询第三方接口并且返回给调用方。使用的是两三年前别人遗留下来的方法,放到线上后发现确实是可以正常取到结果,但是一旦调用,CPU占用就直接100%(部署环境是win server服务器)。因此查看了下相关的老代码并使用JProfiler查看发现是在某个while循环的时候有问题。具体项目代码就不贴了,类似于下面这段代码。while(flag) {//your code;}这里的flag._main函数使用while(1)循环cpu占用99
文章浏览阅读347次。idea shift f6 快捷键无效_idea shift +f6快捷键不生效
文章浏览阅读135次。Ecmacript 中没有DOM 和 BOM核心模块Node为JavaScript提供了很多服务器级别,这些API绝大多数都被包装到了一个具名和核心模块中了,例如文件操作的 fs 核心模块 ,http服务构建的http 模块 path 路径操作模块 os 操作系统信息模块// 用来获取机器信息的var os = require('os')// 用来操作路径的var path = require('path')// 获取当前机器的 CPU 信息console.log(os.cpus._node模块中有很多核心模块,以下不属于核心模块,使用时需下载的是
文章浏览阅读10w+次,点赞435次,收藏3.4k次。SPSS 22 下载安装过程7.6 方差分析与回归分析的SPSS实现7.6.1 SPSS软件概述1 SPSS版本与安装2 SPSS界面3 SPSS特点4 SPSS数据7.6.2 SPSS与方差分析1 单因素方差分析2 双因素方差分析7.6.3 SPSS与回归分析SPSS回归分析过程牙膏价格问题的回归分析_化工数学模型数据回归软件
文章浏览阅读7.5k次。如何利用hutool工具包实现邮件发送功能呢?1、首先引入hutool依赖<dependency> <groupId>cn.hutool</groupId> <artifactId>hutool-all</artifactId> <version>5.7.19</version></dependency>2、编写邮件发送工具类package com.pc.c..._hutool发送邮件
文章浏览阅读867次,点赞2次,收藏2次。docker安装elasticsearch,elasticsearch-head,kibana,ik分词器安装方式基本有两种,一种是pull的方式,一种是Dockerfile的方式,由于pull的方式pull下来后还需配置许多东西且不便于复用,个人比较喜欢使用Dockerfile的方式所有docker支持的镜像基本都在https://hub.docker.com/docker的官网上能找到合..._docker安装kibana连接elasticsearch并且elasticsearch有密码
文章浏览阅读1.3w次,点赞57次,收藏92次。整理 | 郑丽媛出品 | CSDN(ID:CSDNnews)近年来,随着机器学习的兴起,有一门编程语言逐渐变得火热——Python。得益于其针对机器学习提供了大量开源框架和第三方模块,内置..._beeware
文章浏览阅读7.9k次。//// ViewController.swift// Day_10_Timer//// Created by dongqiangfei on 2018/10/15.// Copyright 2018年 飞飞. All rights reserved.//import UIKitclass ViewController: UIViewController { ..._swift timer 暂停
文章浏览阅读986次,点赞2次,收藏2次。1.硬性等待让当前线程暂停执行,应用场景:代码执行速度太快了,但是UI元素没有立马加载出来,造成两者不同步,这时候就可以让代码等待一下,再去执行找元素的动作线程休眠,强制等待 Thread.sleep(long mills)package com.example.demo;import org.junit.jupiter.api.Test;import org.openqa.selenium.By;import org.openqa.selenium.firefox.Firefox.._元素三大等待
文章浏览阅读3k次,点赞4次,收藏14次。Java软件工程师职位分析_java岗位分析
文章浏览阅读2k次。Java:Unreachable code的解决方法_java unreachable code
文章浏览阅读1w次。1、html中设置标签data-*的值 标题 11111 222222、点击获取当前标签的data-url的值$('dd').on('click', function() { var urlVal = $(this).data('ur_如何根据data-*属性获取对应的标签对象