:::info 注意:数据建模模块现已移动到智能BI菜单栏下。 ::: 在无法连接数据库,仅可通过接口查看数据的情况下,若需要使用清册等功能,就需要将数据接口配置成接口建模,进而再将接口建模配置成清册等功能。
简言之,接口建模是为了将线上接口转为数据模型的一个方案

新建接口建模

新增.mp4在数据建模界面,点击左上角的“新建”按钮,弹出模型选择窗口,选择“接口建模”,可完成新建。
接口建模可以通过调用第三方接口创建模型并获取数据,可配置调用接口的地址、请求头、请求参数、返回结果、请求和返回字段的映射关系。

接口配置

配置接口的相关参数,如果有分页的情况需要注意添加分页字段,如果没有则只请求一次

接口URL

调用接口.mp4点击前面的下拉列表可以选择GET或POST数据请求方式。
编辑框中填写接口地址。
点击“调用”按钮可以调用接口,并显示获得的数据。

请求头

请求头.mp4点击请求头一栏下方的空白处,会出现编辑框,填写请求头必须的字段可以完成请求头的添加。
需要填写的字段有:参数名称、值、描述。
添加完请求头后在操作列中会出现“删除”按钮,点击删除按钮可以删除该条请求头。 :::info 注意:请求头并非必填项,根据接口需要填写即可 :::

请求参数

请求参数.mp4点击请求参数一栏下方的空白处,会出现编辑框,填写请求参数必须的字段可以完成请求参数的添加。
需要填写的字段有:参数名称、默认值、描述、参数类型。
其中参数类型分为:分页-条数、分页-页码、筛选参数、特殊参数,具体说明如下:
分页-条数:每页能获取到的最大数据量
分页-页码:当前请求的页数
筛选参数:该参数将会在清册配置中自动配置成筛选条件
特殊参数:该字段仅用于接口请求,不做筛选之用
添加完请求参数后在操作列中会出现“删除”按钮,点击删除按钮可以删除该条请求头。

返回结果

返回结果.mp4当配置完接口并调用成功后,便会显示结果数据。获取来的结果数据将显示在“返回结果”区域。
返回结果区域有两个页签,分别是“返回结果”和“字段解析”,其中返回结果页签下的内容是完整的JSON结构的数据,而字段解析页签下则是数据解析后的内容。
这一步中需要在字段解析页签下选择数据对象和总条数
数据对象为JSON中列表数据部分,总条数需要勾选的是该接口所能获取来的数据总量 :::info 注意:1、数据对象应勾选一个列表字段
2、总条数指的是数据总量,而非当前页的数据量 :::

字段配置

选择字段

选择字段.mp4在左侧字段栏中,点击需要显示的字段,可以添加到右侧维度、指标或时间栏中。只有点选的字段才会在清册配置中显示出来
可以点击窗口左上角的“一键配置”将字段全部添加到右侧窗口中。
当所有字段都添加到右侧窗口中以后,“一件配置”按钮会变成“一键还原”,点击可以取消所有字段的添加

修改字段别名

字段别名.mp4将鼠标放于右侧字段栏的字段之上,会出现两个按钮,点击编辑按钮“image.png”,会弹出别名修改窗口,在窗口中填写字段别名,点击确定按钮,可以完成字段别名的修改

修改字段类型

字段类型.mp4在右侧字段窗口中,可以拖拽各个字段栏中的字段到其他字段栏中(比如从维度拖拽到指标),可以修改字段类型。 :::info 注意:若日期字段是字符串类型,就可以将其在此拖拽到时间栏中,后续便可在清册配置中对其配置日期筛选 :::

模型信息

模型信息.mp4模型信息为当前模型的基本信息,包括模型名称、模型类型、模型编号、模型描述。
其中模型名称是必填项

保存

保存.mp4点击右上角的“保存配置”按钮,可以保存当前模型。或点击“返回”按钮取消编辑。