ESB文档库
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 发布审核

# 接口版本

# 版本展示

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

    4.2.2.2-6

  2. 在“接口版本展示”界面，显示接口版本记录。

    4.2.2.2-7

# 版本信息查看

  1. 在“接口版本展示”界面，点击版本记录操作列“查看”按钮，展示该版本字段信息。

    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

# 发布说明

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

    4.2.2.2-16

  2. 在“发布说明”展示框，展示接口发布说明。

    4.2.2.2-17

# 接口日志

  1. 在“我的发布”界面，选择左侧组织树中API所属节点，再点击API发布记录操作列“日志”按钮，进入接口日志页面。

    4.2.2.2-18

  2. 在“接口日志”页面，展示接口日志信息。

    4.2.2.2-19

# 接口删除

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

    4.2.2.2-20

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

    4.2.2.2-21

# 接口测试

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

    4.2.2.2-22

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

    4.2.2.2-23

# 文档导出

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

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

# 未归类接口

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

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

未归类接口功能：

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

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

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

  3. 在“开发门户 > API管理 > 我的发布“页面，选择需要关联到服务的接口，单击“确定按钮”。

    关联之前，需要创建对应的域、系统和服务。

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

  5. 关联完成后，接口已经关联到了对应的服务中，在树形节点中，以WebService为名称，如下图所示。

← 4.2.2.3.1 系统 →