Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
DCloud
unidocs-zh
提交
6c4fc54f
unidocs-zh
项目概览
DCloud
/
unidocs-zh
通知
3598
Star
108
Fork
921
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
120
列表
看板
标记
里程碑
合并请求
109
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
unidocs-zh
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
120
Issue
120
列表
看板
标记
里程碑
合并请求
109
合并请求
109
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
提交
6c4fc54f
编写于
11月 20, 2022
作者:
雪洛
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
docs: update uniCloud format response
上级
51cc67e1
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
25 addition
and
16 deletion
+25
-16
docs/uniCloud/cf-functions.md
docs/uniCloud/cf-functions.md
+25
-16
未找到文件。
docs/uniCloud/cf-functions.md
浏览文件 @
6c4fc54f
...
...
@@ -207,9 +207,11 @@ uniCloud服务器给客户端返回的数据格式一般是json,但json的格
为了与uni-app前端的API错误回调风格统一,uniCloud响应体规范定义的云端返回信息(尤其是报错时)应包含
`errCode`
和
`errMsg`
。
除此之外响应体规范还包含
`newToken`
字段,用于token的自动续期(云对象接收含有newToken的响应后会自动更新storage内存储的
`uni_id_token`
及
`uni_id_token_expired`
,此行为新增于
`HBuilderX 3.4.13`
)。开发者一般无需关心此数据,uni-app客户端和云端uni-id之间会自动管理token及续期。
#### HBuilderX 3.6.10及之后版本的错误规范
`uniCloud响应体`
示例如下:
错误规范继承自
[
uni错误规范
](
/tutorial/err-spec.md
)
#### HBuilderX 3.6.10之前版本的错误规范
```
json
//
失败返回值
...
...
@@ -219,6 +221,26 @@ uniCloud服务器给客户端返回的数据格式一般是json,但json的格
}
```
-
errCode
errCode在成功时应返回数字
`0`
,失败时应返回一个以插件id开头的“字符串”,每个单词以连字符(
`-`
)分割。做出这样的规定是为了防止不同插件之间出现重复错误码
以
`'uni-id-account-banned'`
错误码为例,
`uni-id`
为插件id,
`account-banned`
为错误缩写。
如果业务开发的代码并不发布插件市场,那么为了避免下载了一个市场的插件产生冲突,推荐使用不包含“-”的字符串来做errCode(插件市场的所有插件ID必须包含“-”)。
后续uniCloud会提供自动根据errCode对errMsg进行国际化处理的功能,开发者仅需保证云函数返回值满足
`uniCloud响应体规范`
即可。
-
errMsg
errMsg用于存放具体错误信息,包括展示给开发者、终端用户的错误信息
#### 请求成功的响应
除此之外响应体规范还包含
`newToken`
字段,用于token的自动续期(云对象接收含有newToken的响应后会自动更新storage内存储的
`uni_id_token`
及
`uni_id_token_expired`
,此行为新增于
`HBuilderX 3.4.13`
)。开发者一般无需关心此数据,uni-app客户端和云端uni-id之间会自动管理token及续期。
`uniCloud响应体`
示例如下:
```
json
//
成功返回值
{
...
...
@@ -236,25 +258,12 @@ HBuilderX内使用代码块`returnu`可以快速输入以下代码(`HBuilderX
```
js
return
{
errSubject
:
''
,
// HBuilderX 3.6.10新增
errCode
:
0
,
errMsg
:
''
}
```
-
errCode
errCode在成功时应返回数字
`0`
,失败时应返回一个以插件id开头的“字符串”,每个单词以连字符(
`-`
)分割。做出这样的规定是为了防止不同插件之间出现重复错误码
以
`'uni-id-account-banned'`
错误码为例,
`uni-id`
为插件id,
`account-banned`
为错误缩写。
如果业务开发的代码并不发布插件市场,那么为了避免下载了一个市场的插件产生冲突,推荐使用不包含“-”的字符串来做errCode(插件市场的所有插件ID必须包含“-”)。
后续uniCloud会提供自动根据errCode对errMsg进行国际化处理的功能,开发者仅需保证云函数返回值满足
`uniCloud响应体规范`
即可。
-
errMsg
errMsg用于存放具体错误信息,包括展示给开发者、终端用户的错误信息
## uniCloud API列表
云函数支持 js 和 nodejs 的标准API,如
`console.log()`
、
`setTimeout()`
,另见
[
nodejs官网
](
https://nodejs.org/en/docs/
)
。nodejs版本,详见
[
云函数运行环境
](
?id=runtime
)
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录