将数据库字段共享开放成接口场景-数据API

1.      场景描述

数据拥有者希望将数据库里的数据提供给使用者,但是为了安全考虑,又不想直接将数据库的用户名和密码提供给对方,这时可以通过调用接口的方式获取数据库里的数据。

2.      场景分析

融合集成平台的数据源管理可以添加数据源,服务集成可以选择需要开放的数据源的库表字段,以restful接口形式对外提供,返回数据格式为JSON

3.      示例详细步骤

  1. [数据源管理]页面,单击<新增>按钮,新增需要对外开放的数据源。

图-1 新增数据源

 

  1. [服务集成/API工厂/API管理]页面,单击<API注册>按钮,选择注册类型为“数据API”。

图-2 选择注册类型

 

  1. 进入数据API设计页面,填写数据API相关信息。

图-3 配置数据API基本信息

 

  1. 基本信息配置完成后,单击<下一步>,进入参数配置页面。配置接口的请求路径,选择刚才配置的数据源及数据源下的数据库、数据表和字段,生成SQL查询语句。

图-4 参数配置

 

  1. 单击<生成参数>,生成接口的输入和输出参数。

图-5 生成接口的输入和输出参数

 

  1. 单击<下一步>,查看配置的数据API的整体信息。

图-6 查看预览信息

 

  1. 查看预览信息无误后,单击<保存>按钮,返回API管理页面。API管理页面可以看到新增的API

图-7 查看API

 

  1. 单击<测试>按钮,进入API测试页面,填写输入输出参数,单击<调用接口>,即可查看测试结果。

图-8 测试API

 

  1. API测试通过后,返回[API管理]页面,单击<API部署>,选择部署的网关节点,将API部署到网关。

图-9 API部署

 

  1. 部署完成后,在[服务集成/API网关/API列表]中可以查看部署到网关的API

图-10 查看部署到网关的API

 

  1. [API列表]页面,单击<授权>按钮,进入API授权页面,将API授权给需要的工作空间、认证方式等。

图-11 API授权

 

  1. 授权完成后在页面下可以查看到已授权的工作空间或应用,单击<测试>按钮,进行接口测试。

图-12 API测试

 

  1. 测试页面的请求路径即网关代理后的地址,配合请求头、输入参数,可以在外部进行接口调用。