Zion API 的配置与使用
API(应用程序编程接口)是连接不同应用与外部数据的桥梁。在 Zion 平台中,API 可用于集成外部数据源,实现数据交互与自动化操作。
API 基础构成
在 Zion 配置 API 前,请先了解 API 的基本要素:
- 方法(Method)
- 域名(Domain)
- 路径(Path)
- 请求头(Headers)
- 查询参数(Query Parameters)
- 请求体(Body)
如需深入了解 API 基础知识,建议查阅相关网络资料。
本文以“从明道云获取数据”为例,演示完整配置流程。
添加 API 配置
-
打开编辑器左上角的“API”菜单,点击“添加配置”。
编辑 API 配置
选择操作类型
此步骤决定 API 的用途:
- 查询:API 作为组件(如列表、页面等)的数据源
- 修改:API 用于行为操作
本例选择“查询”,将 API 作为列表的数据源。
设置请求格式
Zion 支持两种请求格式配置方式:
- 自动解析(推荐):成功发送一次请求后,系统自动解析格式
- 手动配置:开发者手动填写所有参数
自动解析格式流程
-
打开调试模式。
-
填写方法、域名、路径、请求体等信息,点击“发送”。
-
发送成功后,点击“高级”,检查格式是否正确。
-
依次确认“请求参数”和“响应参数”无误。若为更新配置,需合并新旧参数。
-
完成确认后,即可获得标准的 API 请求与响应格式。
API 的使用方式
作为数据源
在列表、选择视图及页面的数据源配置中,可选择类型为“数据源”的 API。
配置时需指定 API 响应中的列表字段及所需入参。
作为行为
若配置了“修改”类型的 API,可在行为列表的“请求”分类下找到并使用。
Last updated on