API
API 是不同应用之间的桥梁;当应用需要和外部数据打通时,往往通过 API 实现。
开始在 Zion 中配置前,请确保你已经了解到 API 的基本构成:方法(Method)、域名(Domain)、路径(Path)、请求头(Headers)、查询参数(Query Parameters)、请求体(Body)。关于 API 的详细内容,请通过网络查询学习。
接下来用“从明道云获取数据”的例子,介绍配置的完整流程。
添加 API
打开编辑器左上角的“API”,并“添加配置”。
编辑 API
1. 选择“操作类型”
此步骤决定 API 是数据源还是行为:
查询: API 作为组件(列表、页面等)的数据源使用
修改: API 作为行为使用
本例中,直接将 API 作为列表的数据源使用,因此选择“查询”。
2. 设置请求的格式
在这一步中,需要确定 API 请求和响应的格式。Zion 提供了两种配置方法:
通过成功发送一次请求,系统自动解析格式(推荐)
开发者手动配置所有内容
系统自动解析格式
首先,打开调试。
然后,将请求的方法、域名、路径、请求体等等内容填写完成,并点击“发送”。
发送成功后,点击“高级”,前往确认格式是否正确。
先后确认“请求参数”、“响应参数”是否正确。如果你是在更新 API 配置,那就会有新旧两份配置,因此需要进行合并操作。
全部确认完毕后,就得到了 API 的请求和响应格式,接下来就可以使用它了。
使用 API
- 作为数据源使用
在列表、选择视图以及页面的数据源中,可以选择数据源类的 API。
在配置时,需要指定 API 的响应中,哪个字段为列表类型,以及需要的入参。
- 作为行为使用
如果配置了“修改”类型的 API,可在行为列表“请求”分类下的“API”中找到它。