Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
erosXXX
uni-app
提交
24351b41
U
uni-app
项目概览
erosXXX
/
uni-app
与 Fork 源项目一致
Fork自
DCloud / uni-app
通知
1
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
U
uni-app
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
24351b41
编写于
2月 19, 2020
作者:
雪洛
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
docs: http trigger
上级
827c3032
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
222 addition
and
0 deletion
+222
-0
docs/uniCloud/_sidebar.md
docs/uniCloud/_sidebar.md
+1
-0
docs/uniCloud/http.md
docs/uniCloud/http.md
+221
-0
未找到文件。
docs/uniCloud/_sidebar.md
浏览文件 @
24351b41
...
...
@@ -10,6 +10,7 @@
*
[
日志输出
](
uniCloud/cf-logger.md
)
*
[
身份认证
](
uniCloud/cf-authentication.md
)
*
[
登录授权
](
uniCloud/authentication.md
)
*
[
HTTP触发
](
uniCloud/http.md
)
*
权限管理
*
[
腾讯云
](
uniCloud/policy-tcb.md
)
<!-- * [阿里云](uniCloud/policy-ali.md) -->
...
...
docs/uniCloud/http.md
0 → 100644
浏览文件 @
24351b41
## 操作场景
HTTP 触发是云开发为开发者提供的 HTTP 访问服务,让开发者可以通过 HTTP 访问到自己的云开发资源。
-
当开启某一函数的 HTTP 访问后,只要根据 HTTP 即可访问到函数,开发者需要关注业务和资源安全。
-
安全:为了保障业务安全性,开发者需在代码中做好权限控制和安全防护,避免未授权访问触发敏感操作。
-
计费:云函数开启了 HTTP 访问后,如果遇到大量恶意访问,消耗云函数资源,开发者可以将触发路径设置为空或关掉该服务空间的 HTTP 触发,停止 HTTP 访问支持。
本文档主要指导您如何在uniCloud web控制台管理和使用云函数 HTTP 访问。
## 操作步骤
### 设置云函数 HTTP 触发路径
1.
登录
[
uniCloud后台
](
https://unicloud.dcloud.net.cn/
)
,选择需要管理的服务空间。
2.
单击左侧菜单栏【云函数】,进入云函数页面。
3.
选中需要配置的函数,编辑【函数配置】,配置访问路径。
![](
https://dcloud-img.oss-cn-hangzhou.aliyuncs.com/uni-app/uniCloud/edit-function-config.png
)
### 绑定自定义域名
1.
单击左侧菜单栏【云函数】,进入云函数页面。
2.
单击【HTTP 触发】,在 HTTP 触发配置窗口中进行配置。
![](
https://main.qcloudimg.com/raw/d57783a65d625708f45f628eddbe9139.jpg
)
>!
>- 每个服务空间最多绑定5个自定义域名。
>- 云开发提供默认域名供体验和测试该特性,域名规范如:`${spaceId}.service.tcloudbase.com`。
>- 绑定自定义域名之前,请先设置您默认域名的 CNAME 记录值为`${spaceId}.service.tcloudbase.com`,CNAME 记录不存在时会导致域名绑定失。
>- 单个服务空间可支持被访问的最大 QPS 为5000,单个云函数可支持被访问的最大 QPS 为2000(具体频次受函数并发限制)。
>- 默认域名可支持被访问的最大 QPS 为200,推荐您绑定自定义域名以获取更大的访问频次。
### 通过 HTTP 访问云函数
-
方式一:通过
`https://${spaceId}.service.tcloudbase.com/${path}`
直接访问函数,其中
`${spaceId}`
是服务空间 ID,
`${path}`
是配置的函数触发路径。
```
sh
$
curl https://
${
spaceId
}
.service.tcloudbase.com/
${
path
}
```
-
方式二:直接在浏览器内打开
`https://${spaceId}.service.tcloudbase.com/${path}`
。
### 云函数的入参
使用 HTTP 访问云函数时,HTTP 请求会被转化为特殊的结构体,称之为
**集成请求**
,结构如下:
```
shell
{
path:
'HTTP请求路径,如 /hello'
,
httpMethod:
'HTTP请求方法,如 GET'
,
headers:
{
HTTP请求头
}
,
queryStringParameters:
{
HTTP请求的Query,键值对形式
}
,
requestContext:
{
云开发相关信息
}
,
body:
'HTTP请求体'
,
isBase64Encoded:
'true or false,表示body是否为Base64编码'
}
```
下面是一个示例:
```
shell
{
path:
'/'
,
httpMethod:
'GET'
,
headers:
{
'host'
:
'env-id.service.tcloudbase.com'
,
'connection'
:
'close'
,
'user-agent'
:
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.88 Safari/537.36'
,
'accept'
:
'text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9'
,
'accept-encoding'
:
'gzip, deflate, br'
,
'accept-language'
:
'zh-CN,zh;q=0.9,en;q=0.8'
}
,
requestContext:
{
requestId:
'cdbb96328072184d19d3fcd243e8cc4d'
,
envId:
'env-id'
, //服务空间Id
appId: 123456789,
uin: 123456789
}
,
isBase64Encoded:
false
,
body:
''
}
```
### 云函数的返回值
云函数可以返回
`string`
、
`object`
、
`number`
等类型的数据,或者返回
[
集成响应
](
#Integrationresponse
)
,随后云接入会将返回值转化为正常的 HTTP 响应。
#### 返回字符串或数字
云函数返回字符串,那么:
```
js
module
.
exports
.
main
=
function
()
{
return
'
hello gateway
'
}
```
最终 HTTP 响应为:
```
shell
HTTP/1.1 200 OK
date
: Mon, 16 Dec 2019 08:35:31 GMT
content-type: text/plain
;
charset
=
utf-8
content-length: 13
hello gateway
```
#### 返回 Object
返回的
`Object`
会被转换为 JSON,同时 HTTP 响应的
`content-type`
会被设置为
`application/json`
:
```
js
module
.
exports
.
main
=
function
()
{
return
{
foo
:
'
bar
'
}
}
```
最终 HTTP 响应为:
```
shell
HTTP/1.1 200 OK
date
: Mon, 16 Dec 2019 08:35:31 GMT
content-type: application/json
;
charset
=
utf-8
content-length: 13
{
"foo"
:
"bar"
}
```
<span
id=
"Integrationresponse"
></span>
#### 返回集成响应
云函数可以返回如下这样特殊结构的
**集成响应**
,来自由地控制响应体:
```
json
{
"isBase64Encoded"
:
true
|
false
,
"statusCode"
:
httpStatusCode
,
"headers"
:
{
"headerName"
:
"headerValue"
,
...
},
"body"
:
"..."
}
```
##### 使用集成响应返回 HTML
将
`content-type`
设置为
`text/html`
,即可在
`body`
中返回 HTML,会被浏览器自动解析:
```
js
module
.
exports
.
main
=
function
()
{
return
{
statusCode
:
200
,
headers
:
{
'
content-type
'
:
'
text/html
'
},
body
:
'
<h1>Hello</h1>
'
}
}
```
最终 HTTP 响应为:
```
shell
HTTP/1.1 200 OK
date
: Mon, 16 Dec 2019 08:35:31 GMT
content-type: text/html
;
charset
=
utf-8
content-length: 14
<h1>Hello</h1>
```
##### 使用集成响应返回 JS 文件
将
`content-type`
设置为
`application/javascript`
,即可在
`body`
中返回 JavaScript 文件:
```
js
module
.
exports
.
main
=
function
()
{
return
{
statusCode
:
200
,
headers
:
{
'
content-type
'
:
'
application/javascript
'
},
body
:
'
console.log("Hello!")
'
}
}
```
最终 HTTP 响应为:
```
shell
HTTP/1.1 200 OK
date
: Mon, 16 Dec 2019 08:35:31 GMT
content-type: application/javascript
;
charset
=
utf-8
content-length: 21
console.log
(
"Hello!"
)
```
##### 使用集成响应返回二进制文件
如果返回体是诸如图片、音视频这样的二进制文件,那么可以将
`isBase64Encoded`
设置为
`true`
,并且将二进制文件内容转为 Base64 编码的字符串,例如:
```
js
module
.
exports
.
main
=
function
()
{
return
{
isBase64Encoded
:
true
,
statusCode
:
200
,
headers
:
{
'
content-type
'
:
'
image/png
'
},
body
:
'
iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAY...
'
}
}
```
最终 HTTP 响应为一张 PNG 图片:
```
shell
HTTP/1.1 200 OK
date
: Mon, 16 Dec 2019 08:35:31 GMT
content-type: image/png
content-length: 9897
<binary payload...>
```
\ No newline at end of file
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录