当数据来自数据库表,且睿治平台能接入该数据源时,可通过【基于数据库表创建】生成其数据接口。
这里以新建以员工姓名模糊匹配为请求参数的员工信息表(YGXX)的数据接口为例。
1) 点击新建,选择【基于数据库表创建】,填写【基础信息】。
其中,“接口名称”、“接口编号”以及“请求路径”均为自定义,且“接口编号”和“请求路径”不能有中文。
2) 按需填写【管理信息】,这里设置的信息会显示在该接口的详情页面。当调用接口遇到问题时,可用于联系接口负责人。
3)点击下一步,进行【配置资源】,先在左侧进行资源选择,选择数据源和数据库连接池中的表或视图,下方会显示表或视图包含的字段信息
4) 配置【请求信息】,在这里我们添加一个请求参数,对员工姓名(USERNAME_)字段做过滤。在字段列表勾选USERNAME_字段,点击请求信息左侧的“>”按钮,可以快速添加请求参数,并配置操作符为“包含”,满足姓名模糊匹配的要求。
另一种添加请求参数的方式是,点击请求信息右侧的“+”按钮,手动填写参数名称和配置字段表达式。
5)配置【响应信息】,这里设置要返回字段数据。调用接口时,输入请求参数值返回响应值,响应信息相当于sql中select后的查询字段。在字段列表勾选响应字段,点击响应信息左侧的“>”按钮,可以快速添加到响应信息。若点击“>>”按钮,可以将全部字段添加到响应信息。
6)点击下一步,填写【文档说明】,按需上传接口说明文档,输入请求示例和响应示例。也可以点击【根据请求信息生成】和【根据响应信息生成】自动生成请求示例和响应示例。
这里上传的接口说明文档和输入的请求示例和返回示例会显示在该接口的详情页面中,方便数据消费者调用该接口。
7)按需进行安全配置,若接口返回数据存在敏感信息,需要加密/脱敏,可以开启“是否进行传输加密”设置。点击添加全部字段,将敏感字段的“是否安全配置”改为“是”,配置“方式”为加密或脱敏,和对应的加密算法/脱敏方式。
配置后,在测试页面或实际使用接口服务时,接口返回对应字段值会进行加密或脱敏。
8)点击下一步,进入测试页面,请求体默认带入输入参数样例的内容,点击【查询】,在响应数据区查看返回数据。如下图,请求参数USERNAME_传“张”,返回员工姓名包含张的数据。点击【保存】完成接口创建。
9)点击【申请发布】,对新建的服务接口进行发布。接口发布成功后,再到接口上下架页面进行上架。接口只有上架成功后才能绑定到资产,绑定到资产后才能申请调用。
请先登录