跳到主要内容

概述

目录​

一、什么是开发部署​

二、开发部署工具​

三、版本管理​

四、流程集成注册为API​

卡片-开发部署图示

一、什么是开发部署​

　　开发部署指创建数据连接或者数据服务，编排集成流程并部署到运行时，以及将API注册到网关的功能。

二、开发部署工具​

　　我们提供了一套完整的开发部署工具链，帮助开发者高效地完成应用程序的部署工作：

  • 创建连接：简化数据源的连接和管理
  • 流程集成：灵活编排多个服务的调用流程
  • 数据服务：基于ESB构建SOAP服务、SAP服务，并提供数据库服务化功能
  • API集成：便捷地注册和管理API服务

三、版本管理​

（一） 功能概述​

　　版本管理用于展示和维护集成资源的各个版本信息，便于用户对不同版本进行查看、切换、编辑、删除等操作。

（二） 主要界面与字段​

　　在“版本”页面中，系统以表格方式展示对应的集成资源的版本信息，表格包含以下字段：

  • 版本号：系统内部维护的版本编号，格式：v1.0、v1.1、v1.2 ...... v1.9、v2.0 ......
  • 版本说明：对该版本的简要描述。
  • 工作状态：当前版本的工作状态（草稿、启用、停用、禁用），并以标签形式高亮显示。
  • 审批状态：仅对API有效，分为注册待审核、变更待审核、撤销待审核、已注册、已变更、已撤销；
  • 测试状态：仅对数据连接、API有效，分为测试通过、未通过、未测试；
  • 所属项目名称：该版本API归属的项目名称。
  • 业务部门：负责该API的业务部门。
  • 启动时间：该版本API的启用时间。
  • 更新时间：该版本API的最后更新时间。
  • 更新人：最后一次更新该版本的人员。
  • 创建时间：该版本API的创建时间。
  • 创建人：创建该版本的人员。

（三） 工作状态​

　　版本管理中的"草稿"状态，表示该版本没有部署到运行时，并且没有进入运行管理的资源列表。

  • 数据连接：

    • v1.0保存后，工作状态为"启用"（无需部署、无需启动）；
    • v1.0点击变更按钮，生成v1.1，工作状态为草稿；
    • v1.1点击切换按钮，工作状态为"启用"；（v1.0工作状态变为停用）

  • 集成流程：

    • v1.0保存后，工作状态为草稿；
    • v1.0点击切换/停止按钮，工作状态变为启用（自动部署、自动启动）；
    • v1.0点击变更按钮，生成v1.1，工作状态为草稿；
    • v1.1点击切换按钮，工作状态变为启用；（v1.0工作状态变为停用）

  • API：

    • v1.0保存后，工作状态为草稿；
    • v1.0点击注册按钮，工作状态为草稿、审批状态为注册待审核；
    • v1.0注册成功后，工作状态仍然是草稿，审批状态变为"已注册"，然后进行API测试；
    • v1.0测试成功后，点击"部署"按钮（发布），部署到运行时并发布到API目录，此时的工作状态变为"启用"；
    • 在API版本管理中，v1.0点击变更按钮，生成v1.1，工作状态草稿，审批状态为变更待切换；
    • v1.1变更成功后（审批通过），工作状态变为启用(自动部署，自动发布)，审批状态变为已变更；(此时，v1.0工作状态变为停用)

（四） 主要操作​

　　点击版本号，可以查看详情。

　　每一行（即每个版本）提供如下操作按钮：

  • 切换/停止：

    • 数据连接

      • 工作状态为"草稿"时，点击切换按钮后，无需部署，无需启动，工作状态变为"启用"；
      • 工作状态为"运行"时，切换按钮显示为“停止”，点击停止按钮后，工作状态变为"停用"。

    • 集成流程 / 数据服务

      • 工作状态为"草稿"时，点击切换按钮后，自动部署并启动，工作状态变为"启用"；
      • 工作状态为"启用"时，切换按钮显示为“停止”，点击停止按钮后，工作状态变为"停用"。

    • API

      • 工作状态为"草稿"时，点击切换按钮后，需要等待审批；审批通过后，进行测试，工作状态仍为"草稿"；
      • 测试成功后，点击"部署"，工作状态变为"启用"；
      • 工作状态为"启用"时，切换按钮显示为“停止”，点击停止按钮后，工作状态变为"停用"。

  • 编辑/变更：

    • 对于数据连接，工作状态为"启用"或者"停用"，显示“变更”；点击变更按钮，生成新的版本号，进入编辑状态；

    • 对于数据连接，工作状态为草稿，显示“编辑”；点击编辑按钮，版本号不变，进入编辑状态；

    • 对于集成流程、数据服务、API，工作状态为启用、停用，显示“变更”；点击变更按钮，生成新的版本号，进入编辑状态；

    • 对于集成流程、数据服务、API，工作状态为草稿，显示“编辑”；点击编辑按钮，版本号不变，进入编辑状态；

    • 对于集成流程、数据服务、API，工作状态为禁用，只能另存或者删除。

  • 删除：

    • 对于数据连接，任何时间都可以删除；
    • 对于集成流程、数据服务、API，工作状态为"草稿"或者"禁用"时，点击删除按钮，删除该版本。

（五） 适用场景​

  • 适用于多版本管理、版本切换、历史版本追溯、版本维护等场景。
  • 支持API生命周期管理，保障API的平滑升级与回滚。

四、流程集成注册为API​

（一） 功能概述​

　　流程集成注册为API功能用于将流程集成注册为API集成，一键注册。

（二） 主要界面与按钮​

　　在“开发工具-流程集成”页面中，流程集成详情页面，已部署的流程集成会有“注册成API”按钮：

卡片-流程集成注册为API图示

（三） 适用场景及说明​

  • HTTP流程集成注册为HTTP穿透代理API：

    • 必要条件：HTTP流程集成处于已部署状态；
    • 注册之后会根据集群创建对应的HTTP连接服务，一般命名：“TUS系统内部'集群名'所属HTTP集成连接服务”。
    • 仅系统当前集群第一个HTTP流程集成服务的注册会创建HTTP连接服务，后续的注册都是共用该连接服务。
    • 注册的API默认使用流程集成的名称，可在点击注册为API按钮之后弹出的弹框中修改。
    • 注册的API为草稿状态，需要有权限的用户进行资源注册、审批、并部署完成之后才可以外部访问该API。
    • 已注册的HTTP流程集成无法在再次注册、卸载或者变更，需要将所对应的API集成删除才可以再次注册、卸载或者变更。

  • SOAP流程集成注册为SOAP穿透代理API：

    • 必要条件：SOAP流程集成处于已部署状态。
    • 注册之后会根据集群创建对应的SOAP连接服务，一般命名：“'API名称'-API专属SOAP连接服务”。
    • 每一个单独的SOAP流程集成注册时都会单独创建一个专属的SOAP连接服务。
    • 注册的API默认使用流程集成的名称，可在点击注册为API按钮之后弹出的弹框中修改。
    • 注册的API为草稿状态，需要有权限的用户进行资源注册、审批、并部署完成之后才可以外部访问该API。
    • 已注册的SOAP流程集成无法在再次注册、卸载或者变更，需要将所对应的API集成以及对应的专属SOAP连接服务删除才可以再次注册、卸载或者变更。

（四） 主要操作​

　　进入“开发工具-左侧资源管理器-流程集成”界面，点击想要注册为API的流程集成，进入集成详情详情页面。

  • 注册为API：

    • 点击“集成注册为API”按钮。

    • 在弹框中填入相关参数：

      • 资源组（必填）：选择API集成所属资源组。
      • API服务名称（必填）：默认为流程集成名称，用户可自定义修改。
      • API服务描述：为API服务添加描述信息，方便管理。
      卡片-集成注册为API弹框图示

    • 点击“确定”按钮，开始注册。

  • 注册完成：

    • 流程集成详情页面会弹窗提示：服务注册成功。

    • 开发工具-数据连接菜单中会生成对应的连接服务：

      • HTTP：TUS系统内部'集群名'所属HTTP集成连接服务。
      卡片-HTTP公用连接服务图示
      • SOAP：'API名称'-API专属SOAP连接服务。
      卡片-SOAP专属连接服务图示

    • 开发工具-API集成菜单中会生成对应的API集成服务。

    卡片-注册成功的API集成图示