接口开发

1.概述

接口开发模块用于新建服务接口，包括开发本地服务接口和注册第三方服务接口，这里新建的接口可与数据资产绑定，为资产消费者提供API服务。本章节主要介绍如何新建服务接口。

2.开发本地服务接口

当数据来自数据库表，且睿治平台能接入该数据源时，可通过【开发本地服务接口】生成其数据接口。

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

1）选择【开发本地服务接口】，填写【基本信息】。

其中，“API名称”、“API编号”以及“路径”均为自定义，且“API编号”和“路径”不能有中文。

2）填写【服务配置】，有两种模式：【表引导模式】和【脚本模式】。【表引导模式】是选择数据库连接池中的表或视图，将表和视图的数据作为数据源；【脚本模式】则是输入sql语句，将sql语句的查询结果作为数据源，点击【帮助文档】可查看支持的语法。

3）填写【请求信息】，这里我们添加一个请求参数name，它对员工姓名(USERNAME)字段做过滤，过滤时是模糊匹配。进行调用接口时，输入请求参数值返回响应值，这里的请求信息相当于sql中的where部分。

【服务配置】选择【脚本模式】时，请求参数可以选择【从sql解析】。

4）填写【响应信息】，这里我们要返回所有字段数据，可以一个一个字段添加，也可一键添加所有字段。进行调用接口时，输入请求参数值返回响应值，响应信息相当于sql中select后的字段。

【服务配置】选择【脚本模式】时，响应参数可以选择【从sql解析】。

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

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

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

7）点击【仅保存】或【保存并测试】完成接口创建。测试的时候需要输入请求体，根据文档说明页面的请求体样例进行填写，然后点击【查询】，在响应数据区查看返回数据。

8）点击【申请发布】，对新建的服务接口进行发布。申请发布后为“审批中”状态，审批通过后接口发布成功。接口只有发布成功后才能被调用。

3.注册第三方服务接口

另外，支持将第三方原始接口地址在平台注册生成一个新的接口地址。原本是请求方发送请求，接口提供方接到请求后，返回结果；注册后，是请求方发送请求，平台接到请求后，发送请求给接口提供方，接口提供方接到请求后返回请求给平台，平台将这个返回结果发给发送方。

这里以注册外部天气数据接口为例。

1）选择【注册第三方服务接口】，填写【基本信息】

2）填写【服务配置】，选择【服务类型】后，输入【外部API服务地址】

3）根据实际情况，填写【请求信息】、【文档说明】和【管理信息】。

4）点击【仅保存】完成接口注册，也可【保存并测试】，同时测试第三方接口是否正确返回。

5）点击【申请发布】，对新建的服务接口进行发布。申请发布后为“审批中”状态，审批通过后接口发布成功。接口只有成功发布后才能被调用。

4.设置API服务申请流程

服务接口和数据资产绑定后，数据消费者在调用接口前需要先申请，若需要审批，则需要为申请接口服务绑定工作流。

如下图，在【绑定工作流】处选择事先做好的工作流即可，工作流的制作见服务申请工作流章节。

如果不绑定工作流，则数据消费者申请调用接口后无需审批自动通过。