iPaaS文档库
00 概述
06 接口服务说明

# API创建

  1. 开发人员登录系统，进入开发门户，点击菜单“API管理”>“API注册”，打开API注册管理界面，左侧显示组织树结构（包括域、系统、服务），右侧显示已创建的API列表。

    4.2.2.1-1

  2. 在“API注册”界面，选择左侧组织树中API所属节点，再点击“API创建”按钮，打开创建API类型选择界面。

    4.2.2.1-2

  3. 选择所要创建API类型（HTTP、WebService、SAP、DB、MQ、WebSocket、Dubbo、gRPC、API编排）及场景。

    4.2.2.1-3

  4. 选择创建接口的类型及场景后，参考具体场景对应章节，完成API创建。

    场景 参考章节
    HTTP 2.1 HTTP服务
    WebService 2.2 WebService服务
    SAP 2.3 SAP服务
    DB 2.4 DB服务
    MQ 2.5 JMS服务
    WebSocket 2.6 WebSocket服务
    Dubbo 2.7 Dubbo服务
    gRPC 2.8 gRPC服务
    API编排 2.9 API编排

# 进入API编排

  1. “API注册”页面，选择左侧组织树中资源节点，右侧API列表页面点击“API编排”按钮。

  2. 若左侧节点API编排的“所属系统”、“所属服务”、“测试服务器”信息未明确配置，则弹出API编排属性配置界面，参考字段说明填写数据，点击“确定”按钮进行保存并跳转至API编排页面。

    参数 说明
    所属系统 API编排所属系统
    所属服务 API编排所属服务
    测试服务器 API编排测试服务器

  3. 在线编排页面，参考 2.8 API编排 进行接口在线编排操作。

# API编辑

  1. “API注册”页面，选择左侧组织树中API所属节点，点击API记录操作列“编辑”按钮，进入API编辑界面。

    4.2.2.1-4

  2. 在“API编辑界面”中，参考相应场景的参数说明，完成API更新，点击“确定”按钮保存更新数据。

    4.2.2.1-5

# API删除

  1. “API注册”页面，选择左侧组织树中API所属节点，点击API记录操作列的“删除”按钮，弹出删除确认界面。

    4.2.2.1-6

提示 已发布接口需取消发布并删除发布记录后才能删除，待发布的接口需在我的发布菜单栏删除发布记录后才能删除。

  1. 点击“确定”按钮，删除API记录。

    4.2.2.1-7

# API发布

  1. “API注册”页面，选择左侧组织树中API所属节点，点击API记录操作列的“发布”按钮，弹出API发布界面。

    4.2.2.1-8

  2. 参考API发布字段说明表格，完成API发布信息填写，点击“确定”按钮，完成API发布。

    4.2.2.1-9

    参数 说明
    代理端口 ESB Server代理API接口的端口
    代理URI ESB Server代理API接口的URL，比如：/test或/api/test
    重试次数 重试次数
    超时时间(毫秒) 请求超时时间，单位毫秒
    发布说明 该接口发布说明
    路由规则 根据条件判断是否对请求进行路由转发，可选“轮询”或“自定义”，选择“自定义”请参考“路由规则参数说明表”，完成参数填写
    请求报文转换 对请求报文格式进行转换，可选“穿透”、“XML转JSON”、“JSON转XML”，请参考“请求报文转换参数说明表”，完成参数填写
    响应报文转换 对响应报文格式进行转换，可选“穿透”、“XML转JSON”、“JSON转XML”，请参考“响应报文转换参数说明表”，完成参数填写
    发布至网关服务器 是否将该接口发布至网关服务器
    选择服务器 选择服务器组，发布接口

    路由规则参数说明表:

    参数 说明
    参数类型 参数位置，可选“请求头”，“客户端IP”、“报文体”
    参数名 参数名称
    条件 参数操作类型，“等于”、“不等于”、“包含”、“不包含”
    参数值 比对的参数值
    目标端点 选择路由的目标端点
    操作 删除：删除该记录

    请求报文转换参数说明表:

    参数 说明
    字段类型 转换报文所在位置，可选”报文体”、“请求头“
    字段名称 字段名称
    新字段名称 替换的新字段名称
    字段赋值 字段值
    value是否是变量 字段赋值的字段值是否是变量的名称，”是“、”否“
    操作 删除：删除该记录

    响应报文转换参数说明表:

    参数 说明
    字段类型 转换报文所在位置，可选”报文体”、“请求头“
    字段名称 字段名称
    新字段名称 替换的新字段名称
    字段赋值 字段值
    value是否是变量 字段赋值的字段值是否是变量的名称，”是“、”否“
    操作 删除：删除该记录

# API Mock测试

  1. “API注册”页面，选择左侧组织树中API所属节点，点击API记录操作列的“Mock”按钮，进入API Mock界面。

    4.2.2.1-10

  2. 在“Mock 操作”界面，进入“期望管理”页签，点击“新建期望”按钮，弹出新建期望页面。

    4.2.2.1-11

  3. 在“新建期望”页面，参考参数说明表格完成字段填写，点击“确定”按钮，完成期望数据保存。

    4.2.2.1-12

    参数 说明
    名称 期望名称
    HTTP状态码 期望业务接口返回的HTTP状态码
    设为默认 设置该期望为默认期望

  4. 填写该期望返回的响应数据，点击“保存”按钮，保存期望数据。

    4.2.2.1-13

  5. 在“Mock 操作”界面，进入“Mock 测试”页签，填写请求参数，点击“发送”按钮，进行测试，测试结果将在“实时响应”窗口展示，测试结果与期望设置相同。

    4.2.2.1-14

# API导入

  1. 在“API注册”界面，选择左侧组织树中API所属节点，再点击“API导入”按钮，打开API导入界面。

    4.2.2.1-15

  2. 在“API导入”界面，点击“下载模板”按钮，下载API模板。

    4.2.2.1-16

  3. 修改下载的API模板。

    4.2.2.1-17

  4. 在“API导入”界面，点击“上传文件”按钮，选择上一步骤修改的模板文件，点击“打开”按钮，上传数据文件。

    4.2.2.1-18

  5. 填写“业务服务地址”，点击“保存”按钮，保存API信息。

    4.2.2.1-19

# API批量删除

  1. 在“API注册”界面，选择左侧组织树中API所属节点，选中需要删除的API接口，点击“批量删除”按钮，弹出删除确认界面 (已发布接口需取消发布并删除发布记录后才能删除，待发布的接口需在我的发布菜单栏删除发布记录后才能删除)。

    发布状态 批量删除条件
    已注册 可直接删除
    待发布 需在我的发布菜单栏删除发布记录后才能删除
    已发布 需在我的发布菜单栏取消发布并删除发布记录后才能删除

# 添加API标签

  1. 在“API注册”界面，选择左侧组织树中API所属节点，鼠标悬浮在标签栏，将显示 + 号，点击 + 号，打开”添加标签”页面。”API标签”相关可参考4.2.2.5 API标签。

  2. 选择需要为接口添加的标签，点击“确定”保存标签信息。

# 根据标签查询API

  1. 在“API注册”界面，选择左侧组织树中API所属节点，点击标签查询按钮，选择标签，点击“搜索”图标，进行接口查询。

  2. 接口列表显示符合标签查询条件的API接口列表。

# API导出

  1. 在“API注册”界面，选择左侧组织树中API所属服务节点，勾选需要导出的API接口，点击“API导出”按钮，即可导出API接口文件。

← 4.2.2.2 我的发布 →