Rest API
使用REST数据源来访问APIs。
在Budibase中REST数据源是一个强大的集成方式,它允许通过http协议来连接数据。
增加新的REST数据源
点击data->sources->Add->Rest->continue按钮来增加rest数据源。
- 为数据源增加额外的配置,在表单里设置queries, 默认headers,授权和变量,点击保存来完成你的修改。
- REST数据源有一个默认的名字,比如REST或者REST-1,可以按照你的名字来修改它。
查询
查询就是在rest 数据源里的每个api请求,可以通过scratch来创建或者导入存在的请求来创建它。
创建新的请求
首先,创建一个REST数据源,点击add query按钮来打开查询编辑器。
命名查询
给你的查询取个适合的名字,比如,获取所有应用列表的查询命名为applications。
API端口url
输入API端口URL,url包括协议,域名以及路径
请求方法
get, post, put, delete 方法可供选择。
访问级别
设置登陆的终端用户的访问级别,如果用户访问的页面里包括此查询,并且访问此查询的级别超过了用户的访问级别,这个查询不能运行。
请求参数
-
URL参数可以被配置在params标签里。参数是可以被添加在url请求后的查询参数,它们可以被硬编码或者通过bindings或者变量传入。
bindings(绑定)
用绑定来为查询提供额外的信息。以上面的?status=all&other=value 为例子,可以使用一个命名为status的bindings来替换硬编码的all值,这个绑定可以设置默认值为all,这样我们就可以在使用此查询的应用里改变status绑定的值来执行不同的查询。
headers
用headers来提供api所需要的key-value键值对。
- 可以通过开关来控制是否发送此header。
-
headers可以硬编码或者使用REST bindings或者变量来替换。
Body
请求的消息体。content-type支持的类型
* raw(JSON) / application/json
* raw(XML) / application/xml
* raw(Text) / text/plain
转换(transformer)
transformer可以用来增强返回的数据。后续会详细讲解transformer的使用。
认证
为REST数据源配置认证策略,可以用它来认证查询。后续会详细讲解REST Authentication的使用。
发送请求
当查询配置完成后,可以使用send 按钮来预览查询结果,当查询被成功执行时,可以使用save query来保存查询。
使用response数据
当查询被成功执行时,使用save query来保存查询。接着保存的查询可以被用作data provider(https://docs.budibase.com/docs/data-provider) 的数据源或者被Execute Query action所用。
修改Schema
返回的schema可以被以下方式更新
- 新增或者移动字段
- 当在表中显示结果时改变字段类型
创建动态变量
返回的schema和headers可以被用来创建动态变量,静态变量和动态变量将会REST Variables章节中介绍 。