API 配置说明
阅读本篇内容前,请先熟悉了解《API 基础知识》,并在 Postman 或者其他调试工具中成功调试 API
Zion 目前仅支持基于 http 的,请求格式为 application/json 的 API
API 配置添加入口
点击编辑器左上角的【第三方 API 】按钮,即可进入添加 API 的界面,点击添加配置给 API 命名后即可添加一个新的 API
调试 API 配置
添加了 API 之后,点击展开 API 配置界面,点击右侧【编辑】按钮才可以开始进行 API 的配置,按照如下步骤配置并调试 API
- 选择 API 的操作类型: 查询类 API,修改类 API
- 直接点击「调试」按钮,在「调试」中直接进行配置,调试方法实际上类似于在 Postman 中进行调试
GET 请求
以配置请求天气 API 接口为案例,接口文档:【天气API】,如果你想要正常使用该接口,请先到这里注册:【天气API注册】,获取 API 的appid、appsecret 在 Zion 中配置时,选择请求方式为 GET,根据接口文档复制请求地址到地址栏中,在请求的 QUERY/HEADER 中根据接口文档配置对应的参数名称以及参数内容,配置完成后直接点击发送 ,即可看到响应内容 如果 API 返回的内容均为文本或者数字类型的数据,调试成功之后直接点击【保存配置】即可
POST 请求
目前 Zion 仅支持 BODY 为 JSON 类型的 API以配置 AI 生成图片的 API 接口为例,接口文档:【画宇宙图片处理API】,如果你想要正常使用该接口,请先到这里注册:【画宇宙开放平台】,新增应用,获取 API Token 在 Zion 中配置时,选择请求方式为 POST,根据接口文档复制请求地址到地址栏中,在请求的 BODY/HEADER 中根据接口文档配置对应的 JSON 格式的请求体以及其他参数内容,配置完成直接点击发送 ,即可看到响应内容
媒体资源解析
- 请求配置成功时,如果图片/媒体数据是一个 URL 的字符串,如下图所示 ⬇️ “cdn”字段是 API 文档规定的,返回的图片结果,如果想要在 Zion 中拿到这张图片使用
- 那么点击配置界面右上角的【高级】按钮,进入高级配置
- 点击前进到「配置-响应参数」界面,可以看到右边被解析为 JSON 格式的返回值,你可以将 TEXT 格式的返回值进行类型转换,如果是单张图片/单个视频直接解析为“URL 媒体编码”即可
- 请求配置成功时,如果图片/媒体数据是一个 URL 的字符串数组对象,如下图所示 ⬇️ “image”就是一个字符串数组对象,如果要将这个图片拿到 Zion 中使用,需要将这个“image”字段的格式转换为“JSON”字符串编码
- 图片/媒体数据是一个字符串类型的数组,无法通过直接配置获取到对应的数据,你可以通过【行为流调用API】来实现数据的交互## 调用配置好的 API
调用「查询」类API
查询:如果选择 API 的操作类型为查询,那么意味着你想向 API 提供商查询获取单条或者多条数据,当 API 操作类型为查询时,在 Zion 中你才可以在列表类组件的远程数据中/页面的内容中选择/添加这个 API 请求
img | img |
---|---|
展示单条数据
以查询当天天气情况为例, API 返回的数据其中包含了多个字段,例如:tem(实时温度)、tem1(高温)
如果想要在 Zion 的页面上直接显示某个/某些组件的具体数据,按照如下步骤完成配置,而后在页面上拖入组件,例如文字组件,给文字组件绑定上对应的页面数据即可
- 直接在页面的组件的内容中绑定「页面内数据-远程数据」,选择对应的字段即可
- 在 Zion 的页面中添加「第三方API数据」的 API 请求,选择对应的 API,在其成功时利用【设置页面数据】行为,将 API 请求的结果(页面内数据-远程数据-API)赋值给到页面数据
展示多条数据
如果 API 返回的是多条数据,那么需要使用「列表类」组件,进行 API 请求的配置以及数据的展示,配置完成之后,直接进入「列表类」组件中,拖入相应的组件利用组件内数据进行数据绑定即可
调用「修改」类 API
修改:如果选择 API 的操作类型为修改,那么意味着你想要通过交互行为来查询或者修改 API 提供商的数据,API 操作类型为修改时,在 Zion 中你才可以在组件的交互行为中添加这个 API 的请求
查询(读取)单条/多条数据
通过点击时行为配置第三方 API 来查询数据,为了在页面上展示/使用查询的结果,你同样需要在页面中添加相应的页面数据来绑定 API 执行成功时的查询结果
修改第三方数据
在组件的交互行为中配置对应的第三方 API ,在 API 中配置需要修改的内容即可,操作方法与《Zion 的写入操作方法》相似