功能简介

主数据服务可以快速创建一个服务接口，该接口可以查询选中的主数据模型的表数据。

服务接口

创建接口

• 首先选中需要创建接口的模型，点击【创建接口】，点击【服务接口】
  

• 进入服务接口设置页面，设置好基础配置、服务配置等信息后，点击保存即可。
  

• 这样就创建好了第一个接口，列表中会显示主数据模型、接口名称、接口编码、请求方式、服务类型、接口类型、匿名访问、创建时间、修改时间、以及可操作的功能。
  

编辑接口

点击【编辑接口】，进入编辑页面，此时编码和路由地址无法修改。

基础配置

• 接口名称：由用户自定义接口名称。
• 编码：填写接口名称后自动生成，只能由字母、数字组成。
• 测试环境：分为本地环境（localhost）和开发环境（域名）。可在数据库添加新环境选项。

• 路由地址：服务路由地址，可以通过创建数据服务时自定义。
• 接口协议：接口间遵循的通信方式，目前只支持HTTP。
• 请求方式：GET（请求获取数据）或POST（发送数据）。
• 接口类型：Restful或WebService。
• 匿名访问：是否可以通过匿名代理访问该接口，若为匿名，则可在第三方平台直接调用。若为非匿名，则请求时需要token。
• 接口路径：根据路由地址和编码自动生成一个规范化接口。

服务配置

• 参数列表：可在此添加参数。
• 过滤条件：可设置查询数据的过滤条件，返回数据会显示为过滤后的数据。

格式预览

根据选择的接口类型预览请求和返回格式。

• Restful：
  

• WebService：
  

描述信息

选填，对该接口进行说明。

发布新版本

编辑完毕后，点击发布新版本。

在导出的接口文档中可以查看旧版本，暂不支持版本管理。

测试接口

基本配置

预览在编辑页面设置的各项属性。

请求参数示例

在此可以直接填写请求数据，无需加引号。

• 树：
  

• 文本：
  

返回数据示例

预览接口

接口详情

该页面主要是查看接口的各项配置，无法编辑。

• 基本配置和接口描述：
  

• 返回数据：查看表字段的信息。
  

• 请求数据和返回数据：
  

SQL接口

创建接口

• 首先选中需要创建接口的模型，点击【创建接口】，点击【SQL接口】
  

• 进入SQL接口设置页面，设置好基础配置、服务配置等信息后，点击保存即可。
  

• 这样就创建好了第一个SQL接口，列表中会显示主数据模型、接口名称、接口编码、请求方式、服务类型、接口类型、匿名访问、创建时间、修改时间、以及可操作的功能。
  

编辑接口

点击【编辑接口】，进入编辑页面，此时编码和路由地址无法修改。

基础配置

• 接口名称：由用户自定义接口名称。
• 编码：填写接口名称后自动生成，只能由字母、数字组成。
• 测试环境：分为本地环境（localhost）和开发环境（域名）。可在数据库添加新环境选项。

• 路由地址：服务路由地址，可以通过创建数据服务时自定义。
• 接口协议：接口间遵循的通信方式，目前只支持HTTP。
• 请求方式：GET（请求获取数据）或POST（发送数据）。
• 接口类型：Restful或WebService。
• 匿名访问：是否可以通过匿名代理访问该接口，若为匿名，则可在第三方平台直接调用。若为非匿名，则请求时需要token。
• 接口路径：根据路由地址和编码自动生成一个规范化接口。

服务配置

• SQL编辑器：可在此输入SQL语句。
• 参数列表：可在此添加SQL参数。

格式预览

根据选择的接口类型预览请求和返回格式。

• Restful：
  

• WebService：
  

描述信息

选填，对该接口进行说明。

发布新版本

编辑完毕后，点击发布新版本。

在导出的接口文档中可以查看旧版本，暂不支持版本管理。

测试接口

基本配置

预览在编辑页面设置的各项属性。

请求参数示例

在此可以直接填写请求数据，无需加引号。

• 树：
  

• 文本：
  

返回数据示例

预览接口

接口详情

该页面主要是查看接口的各项配置，无法编辑。

• 基本配置和接口描述：
  

• 请求数据和返回数据：
  

导出文档

参考：导出接口文档