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

我的发布页面，显示已经发布或保存未发布的所有接口信息。

# 接口编辑

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

    4.2.2.2-1

  2. 在“我的发布”界面，选择左侧组织树中API所属节点，再点击API发布记录操作列“编辑”按钮，打开API编辑界面

    4.2.2.2-2

  3. 在“API编辑”界面，更新API信息，点击“确定”按钮，保存API信息。

    4.2.2.2-3

  4. API接口编辑后，需要重新进行接口发布审核，详见 4.1.4.1 发布审核

# 取消发布

  1. 在“我的发布”界面，选择左侧组织树中API所属节点，再点击API发布记录操作列“取消发布”按钮，弹出取消发布提示框。

    4.2.2.2-4

  2. 点击“确定”按钮，取消API接口发布。

    4.2.2.2-5

  3. 取消发布后，需要进行接口取消发布审核，才可生效，详见 4.1.4.1 发布审核

# API文档

  1. 在“我的发布”界面，选择左侧组织树中API所属节点，再点击API发布记录的接口名称，弹出接口详情展示界面。

    4.2.2.2-6

  2. 在“API文档”页签，显示API接口信息。

    4.2.2.2-7

# API策略

说明：接口未配置API策略的情况下，默认使用在线令牌进行安全验证。

  1. 点击API记录的接口名称，进入接口详情展示界面，在“API策略”页签，展示该接口API策略设置详情。

    4.2.2.2-17

  2. 点击“搜索策略”按钮，可通过名称、类型搜索API策略。

    4.2.2.2-17

  3. 点击具体API策略标签，“搜索策略”按钮，该标签右上角出现已选择标识，并且该API策略出现在已选择框表明该策略已被选择，再次点击已选择的策略，可撤销选择的API策略。

    4.2.2.2-17

  4. 点击“新建策略”按钮，新增API策略。

    4.2.2.2-17

  5. 选择具体的API记录标签，点击“查看详情”按钮，可查看该API策略的详细情况。

    4.2.2.2-17

  6. 选择具体的API记录标签，点击“复制并新建”按钮，可依据该API策略创建同类型的初始数据相同的API策略。

    4.2.2.2-17

  7. 选择具体的API记录标签，点击“编辑”按钮，可编辑该API策略信息。

    4.2.2.2-17

  8. 选择具体的API记录标签，点击“删除”按钮，可删除该API策略记录。

    4.2.2.2-17

# API测试

  1. 在“我的发布”界面，选择左侧组织树中API所属节点，再点击审核状态为“已发布”或“审核通过”的API记录接口名称，进入接口详情页面。

    4.2.2.2-22

  2. 在“接口详情”页面，进入“API测试”页签，按业务接口的需求，填写访问配置项，点击“测试”按钮，进行接口测试。

    4.2.2.2-23

# API版本

# 版本展示

  1. 在“我的发布”界面，选择左侧组织树中API所属节点，再点击API发布记录的接口名称，弹出接口详情展示界面。

    4.2.2.2-6

  2. 在“API版本”页签，显示接口版本记录。

    4.2.2.2-7

# 版本信息查看

  1. 点击API记录的接口名称，进入接口详情展示界面，在“API版本”页签，点击版本记录操作列“查看”按钮，展示该版本字段信息。

    4.2.2.2-8

  2. 展示该版本信息。

    4.2.2.2-9

# 版本删除

  1. 在“接口版本展示”界面，点击该接口非当前发布版本的操作列“删除”按钮，弹出版本删除提示框。

    4.2.2.2-10

  2. 点击“确定”按钮，删除接口该版本信息。

    4.2.2.2-11

# 版本发布

  1. 在“接口版本展示”界面，点击该接口非当前发布版本的操作列“发布”按钮，弹出版本发布提示框。

    4.2.2.2-12

  2. 点击“确定”按钮，发布该接口版本。

    4.2.2.2-13

  3. 接口发布后，需要进行接口发布审核，才可生效，详见 4.1.4.1 发布审核

# 版本比较

  1. 在“接口版本展示”界面，选择两个版本，点击“发布比较”按钮，弹出版本比较界面。

    4.2.2.2-14

  2. 在“版本比较”界面，展示两个版本差异情况。

    4.2.2.2-15

# API日志

  1. 点击API记录的接口名称，进入接口详情展示界面，在“API日志”页签，展示接口日志信息。

    4.2.2.2-19

# 业务异常校验

说明：只有 HTTP穿透、HTTP路由、HTTP转WS、WebService穿透、WS转HTTP、dubbo转HTTP、gRPC转HTTP 类型的接口存在“业务异常校验”页签。

  1. 点击API记录的接口名称，进入接口详情展示界面，在“业务异常校验”页签，展示业务异常校验页面。

    4.2.2.2-19

  2. 业务异常校验只针对正常响应的报文进行校验（支持对json报文和xml报文进行校验），如果接口开启业务异常校验功能，当业务接口响应状态码是4xx或5xx时，不进行业务异常校验（也不会返回自定义响应状态码和自定义响应报文）。只有业务接口响应状态码不是4xx或5xx时，才会进行业务异常校验。

  3. 业务异常校验会根据用户配置的条件判断是否属于业务异常，当业务接口的响应报文符合判断条件时，认为是业务异常，调用日志记录的状态是“异常”，如下所示：

  4. 业务异常校验支持自定义响应状态码和自定义响应报文，当业务接口的响应报文被判定为业务异常时，如果用户配置了自定义响应状态码和自定义响应报文，则返回自定义响应状态码和自定义响应报文，没有配置则返回原状态码和原报文。

  5. 自定义响应报文支持变量替换，将原报文中的部分内容通过变量的方式加到自定义响应报文中（如果原报文是json格式，则变量为jsonpath，如果原报文是xml格式，则变量为xpath），如下所示：

  6. 业务异常校验支持自定义业务校验类，以下是自定义业务异常校验类操作步骤：
    6.1 API-Gateway自定义业务校验需要引入gateway-core-9.1.0.jar，ESB-Server自定义业务校验需要引入com.primeton.esb.httpcomponent.client.nio-9.1.0.jar。
    6.2 自定义业务异常校验类必须实现IHttpResponseChecker接口。
    6.3 在businessResultCheck方法编写自定义校验规则，可以在方法内定义响应状态码和响应报文，自定义业务异常校验类参考：DemoResultCheck.java。
    6.4 自定义校验类编写完成后，进行打包，将打好的jar包放在API-Gateway的lib目录或者ESB-Server的server/libs目录，重启API-Gateway或ESB-Server。
    6.5 在业务异常校验配置页面，开启自定义校验，在校验类路径填写自定义业务异常校验类的全类名。

开启自定义业务异常校验后，业务异常校验只使用自定义业务异常校验，异常校验条件、自定义响应状态码和自定义响应报文将不会生效。

# 发布说明

  1. 点击API记录的接口名称，进入接口详情展示界面，在“发布说明”页签，展示接口发布说明。

    4.2.2.2-17

# 接口删除

  1. 在“我的发布”界面，选择左侧组织树中API所属节点，再点击审核状态为“待发布”的API记录的操作列“删除”按钮，弹出接口删除提示框。

    4.2.2.2-20

  2. 点击“确定”按钮，删除接口记录。

    4.2.2.2-21

# 文档导出

  1. 在“我的发布”界面，选择左侧组织树中API所属节点，选择需要导出的API接口，点击“文档导出”按钮，弹出文档导出提示框。

  2. 点击“确定”按钮，导出API文档。

# 未归类接口

对离线模型进行了进一步的管理:

  • 1、离线模型的接口可以关联到服务下
  • 2、接口名称对应studio创建代理服务时，填写的显示名称
  • 3、卸载模型时，如果离线接口已关联服务，则不可以卸载
  • 4、重新部署模型时，若离线接口已关联服务，则不需要再次关联

未归类接口功能：

  • 未归类接口是通过ESB Studio 开发的模型，导出成 ECD、EPD后，在【模型部署】模块进行部署的接口
  • 主要针对于HTTP和WebService协议

  1. 将导出的模型在“开发门户 > API管理 > 模型部署“页面进行导入。

  2. 当接口从“模型部署“部署后，如果该接口是新增的接口，则出现在未归类接口中，如下图所示。

  3. 在“开发门户 > API管理 > 我的发布“页面，在未归类接口类别中，选择记录点击操作列“关联服务”按钮，打开关联服务界面。

  4. 为未归类接口选择关联的服务，并参考字段说明填写信息，单击“确定”按钮保存信息。

参数 说明
接口编码 接口编码
接口名称 接口名称
请求方式 请求方式，可选GET、POST、DELETE、PUT、PATCH
接口描述 域的备注信息
关联之前，需要创建对应的域、系统和服务。

  1. 关联完成后，关联成功的接口在未归类接口中不再显示，如下图所示。

  2. 关联完成后，接口已经关联到了对应的服务中，如下图所示。

# 接口上线、下线操作

  1. 在“我的发布”界面，选择左侧组织树中API所属节点，选择需要下线的API发布记录，点击该记录状态列的开关按钮，下线接口。

  2. 在“我的发布”界面，选择左侧组织树中API所属节点，选择需要上线的API发布记录，点击该记录状态列的开关按钮，上线接口。

← 4.2.2.3.1 系统 →