测试文档(产品帮助文档专用)

基于sql语句创建接口

当数据来自数据库表,且睿治平台能接入该数据源时,可通过【基于sql语句创建接口】生成其数据接口。

这里以新建以员工姓名模糊匹配为请求参数的员工信息表(YGXX)的数据接口为例。

 

1)点击新建,选择【基于数据库表创建】,填写【基础信息】。

其中,“接口名称”、“接口编号”以及“请求路径”均为自定义,且“接口编号”和“请求路径”不能有中文。

2) 按需填写【管理信息】,这里设置的信息会显示在该接口的详情页面。当调用接口遇到问题时,可用于联系接口负责人。

3) 点击下一步,进行【配置资源】,先选择数据源,再输入sql语句,将sql语句的查询结果作为数据源,点击【帮助文档】可查看支持的语法。

需求是根据员工姓名模糊查询员工信息表数据,因此sql语句(oracle)写成:select USERID_, USERNAME_, YGID, XB from YGXX where USERNAME_ like '%' || #{name} || '%'

4) 填写【请求信息】,可以点击【获取请求参数】按钮,会从sql语句中解析出请求参数。

5)填写【响应信息】,可以点击【获取响应字段】按钮,会从sql语句中解析出响应字段。

 

6)点击下一步,填写【文档说明】,按需上传接口说明文档,输入请求示例和响应示例。也可以点击【根据请求信息生成】和【根据响应信息生成】自动生成请求示例和响应示例。

这里上传的接口说明文档和输入的请求示例和返回示例会显示在该接口的详情页面中,方便数据消费者调用该接口。

7)按需进行安全配置,若接口返回数据存在敏感信息,需要加密/脱敏,可以开启“是否进行传输加密”设置。点击添加全部字段,将敏感字段的“是否安全配置”改为“是”,配置“方式”为加密或脱敏,和对应的加密算法/脱敏方式。

配置后,在测试页面或实际使用接口服务时,接口返回对应字段值会进行加密或脱敏。

8)点击下一步,进入测试页面,请求体默认带入输入参数样例的内容,点击【查询】,在响应数据区查看返回数据。如下图,请求参数name传“张”,返回员工姓名包含张的数据。点击【保存】完成接口创建。

9)点击【申请发布】,对新建的服务接口进行发布。接口发布成功后,再到接口上下架页面进行上架。接口只有上架成功后才能绑定到资产,绑定到资产后才能申请调用。

附件列表

0

文档内容仅供参考
如果您需要解决具体问题,还可以登录亿信社区
在提问求助板块提问,30分钟内帮您解决问题

如果您认为本词条还有待完善,请编辑

上一篇基于数据库表创建接口

下一篇基于数据资产创建接口

请先登录