Budibase数据之Rest API

Rest API

使用REST数据源来访问APIs。
在Budibase中REST数据源是一个强大的集成方式,它允许通过http协议来连接数据。


image.png

增加新的REST数据源

点击data->sources->Add->Rest->continue按钮来增加rest数据源。


image.png
  • 为数据源增加额外的配置,在表单里设置queries, 默认headers,授权和变量,点击保存来完成你的修改。
  • REST数据源有一个默认的名字,比如REST或者REST-1,可以按照你的名字来修改它。

查询

查询就是在rest 数据源里的每个api请求,可以通过scratch来创建或者导入存在的请求来创建它。

创建新的请求

首先,创建一个REST数据源,点击add query按钮来打开查询编辑器。

image.png

命名查询

给你的查询取个适合的名字,比如,获取所有应用列表的查询命名为applications。


image.png
API端口url

输入API端口URL,url包括协议,域名以及路径


image.png
请求方法

get, post, put, delete 方法可供选择。


image.png
访问级别

设置登陆的终端用户的访问级别,如果用户访问的页面里包括此查询,并且访问此查询的级别超过了用户的访问级别,这个查询不能运行。


image.png
请求参数
  • URL参数可以被配置在params标签里。参数是可以被添加在url请求后的查询参数,它们可以被硬编码或者通过bindings或者变量传入。


    image.png
bindings(绑定)

用绑定来为查询提供额外的信息。以上面的?status=all&other=value 为例子,可以使用一个命名为status的bindings来替换硬编码的all值,这个绑定可以设置默认值为all,这样我们就可以在使用此查询的应用里改变status绑定的值来执行不同的查询。


image.png
headers

用headers来提供api所需要的key-value键值对。

  • 可以通过开关来控制是否发送此header。
  • headers可以硬编码或者使用REST bindings或者变量来替换。


    image.png
Body

请求的消息体。content-type支持的类型
* raw(JSON) / application/json
* raw(XML) / application/xml
* raw(Text) / text/plain


image.png
转换(transformer)

transformer可以用来增强返回的数据。后续会详细讲解transformer的使用。

image.png

认证

为REST数据源配置认证策略,可以用它来认证查询。后续会详细讲解REST Authentication的使用。

image.png

发送请求

当查询配置完成后,可以使用send 按钮来预览查询结果,当查询被成功执行时,可以使用save query来保存查询。


image.png
使用response数据

当查询被成功执行时,使用save query来保存查询。接着保存的查询可以被用作data provider(https://docs.budibase.com/docs/data-provider) 的数据源或者被Execute Query action所用。

修改Schema

返回的schema可以被以下方式更新

  • 新增或者移动字段
  • 当在表中显示结果时改变字段类型
创建动态变量

返回的schema和headers可以被用来创建动态变量,静态变量和动态变量将会REST Variables章节中介绍 。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,362评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,330评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,247评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,560评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,580评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,569评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,929评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,587评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,840评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,596评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,678评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,366评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,945评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,929评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,165评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,271评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,403评论 2 342

推荐阅读更多精彩内容