# 接口配置
# 1. 概述
接口配置模块为平台提供统一的第三方系统接口信息维护功能,主要功能包含: 查询、新增、 编辑、删除、接口测试、 导入、导出、 数据日志、数据生命周期
# 2. 查询接口配置
【菜单路径:】系统管理–->接口管理–->接口配置
接口配置可以根据编码、名称、来源分类进行检索。来源分类下拉列表来源自数据字典。
# 3. 新增接口配置
点击新增按钮,跳转至添加接口配置页面,如下图所示:
- 接口配置信息说明
属性名 | 属性说明 |
---|---|
编码 | 接口编码,唯一。必填项 |
名称 | 接口名称,必填项。 |
类型 | 接口类型。restful、soap |
方式 | 请求方式。post、get |
协议 | 协议。http、https |
API前缀 | 接口地址的api前缀。必填。例:10.1.25.7:8080或者www.webxml.com.cn |
来源分类 | 接口所属的来源分类。分类下拉数据来自数据字典,可按需扩充 |
接口url | 接口地址的路径。必填。例:/api/plateNumber/index或/WebServices/IpAddressSearchWebService.asmx?wsdl |
方法 | 接口方法名。当类型为soap时显示,必填。 |
命名空间 | 接口的命名空间(即targetNamespace)。 当类型为soap时显示,必填。 |
结果节点 | 接口返回数据的接收节点,用于数据解析。当类型为soap时显示。 |
超时响应 | 接口的最大响应时长。 |
是否启用 | 接口是否启用。true/false |
请求参数 | 请求参数包含请求头 、params参数 、SOAP标头 、请求体 、form-url参数 。当类型为restful:方式为post,显示请求头 、请求体 、form-url参数 ;方式为get,显示请求头 、params参数 。当类型为soap:显示请求头 、SOAP标头 、请求体 |
返回参数 | 返回参数的结构维护。 |
示例数据 | 示例数据。可用于假数据功能测试。 |
注意
form-url参数:指当请求方式为post时,接口入参类型需要为x-www-form-urlencoded(键值对形式)的请求方式。
请求体:指body参数的层级结构
# 4. 编辑接口配置
通过点击表格行的编辑按钮跳转修改页,来对接口配置信息进行修改。如下图所示:
接口配置信息详见上文新增接口配置
# 5. 删除接口配置
删除接口配置的数据,包含单条数据删除和多条数据删除。
- 单条删除
点击某一条记录后的【删除】按钮,弹出删除确认框,点击【确定】执行删除操作。
- 多条删除
勾选一条或者多条记录,点击【删除】按钮,弹出删除确认框,点击【确定】执行删除操作。
# 6.配置多语言接口
接口使用多语言时,在【修改接口 - 请求参数 - 请求头 - 参数类型】中选择动态值项,【值】列选择当前语言,【参数字段】为 language,【参数名称】自定义。保存成功后,将自动为接口拼接语言字段
# 7. 接口测试
点击某一条记录后的【测试】按钮,弹出页面。如下图所示:
测试页面提供参数生成和调用。部分参数需要自填补充。
# 8.导入接口配置
接口配置提供表格的导入功能,点击导入下载模板,维护数据选择导入类型即可导入接口配置数据。
# 9.导出接口配置
接口配置提供表格的导出功能,点击导出按钮选择需要导出的字段,即可导出接口配置数据。
# 10.接口配置数据生命周期
接口配置提供生命周期的查看功能,勾选表格行选中框,点击生命周期即可查看该条数据的生命周期信息。