接口管理

平台运营人员对接口详细信息进行补充完善后,可以对接口执行上架操作。接口上架后,则该能力(对应的所有版本)将展示在中台官网页面上。本文为您介绍如何上架和下架接口等操作。

前提条件

已构建能力目录。具体操作,请参见管理能力目录

上架接口

  1. 登录BizWorks,在选择平台下拉列表中选中能力开放平台。单击运营页签。image.png

  2. 能力开放平台导航栏中,选择能力开放管理 > 接口管理

  3. 可选:接口管理页面的左侧导航栏中,您可以选择业务视角应用视角,然后单击目标目录节点,查看目标目录节点下的接口列表。

    说明

    接口管理页面,默认展示全部接口。

    image.png

  4. 单击目标接口右侧操作列下的编辑

  5. 接口详情编辑页面,完成配置信息填写。

    1. 填写基础信息,包含简介、负责人以及所属目录。其中,接口负责人可以多选。选中后,负责人将会收到该接口的申请信息,并可以进行审批。

    2. 可选:填写适用场景,包含标题和介绍,并设置图标。

    3. 可选:填写商业价值,包含标题和介绍,并设置图标。

    4. 可选:添加接入步骤,指导业务方如何接入能力,包含步骤标题、角色名称、步骤介绍,并设置标签色。

    5. 可选:查看版本记录(系统自动生成不支持修改)。

    6. 可选:添加常见问题,指导业务方进行一些常见问题处理。

  6. 接口详情编辑页面右上角单击保存草稿预览提交

    说明

    如果您选择预览,则可以查看该接口在开放门户的显示效果;如果您选择提交,系统会保存本次编辑的内容。

  7. 接口管理页面,您可以根据以下三种方式上架接口。

    • 方式一:上架单个接口。单击目标接口右侧操作列下的上架image.png

      如果接口没有相应负责人信息,则需在接口上架对话框中,完成接口负责人设置后,单击提交image.png

    • 方式二(批量上架):根据所选能力批量上架接口。

      1. 选中多个目标接口,在页面右上角的批量操作下拉列表中选择根据所选能力批量上架image.png

      2. 根据所选能力批量上架对话框中,设置接口负责人后,单击提交image.png

    • 方式三(批量上架):根据所选择应用批量上架接口。

      1. 批量操作下拉列表中选择根据所选应用批量上架

      2. 选择应用批量上架对话框中,完成应用选择和设置接口负责人后,单击提交即可。image.png

下架接口

接口管理页面,您可以根据以下三种方式下架接口。

  • 方式一:接口管理页面,单击目标接口右侧操作列下的下架

  • 方式二(批量下架):根据所选能力批量下架接口。

    1. 选中多个目标接口,在页面右上角的批量操作下拉列表中选择根据所选能力批量下架

    2. 根据所选能力批量下架对话框中,设置接口负责人后,单击提交

  • 方式三(批量下架):根据所选择应用批量下架接口。

    1. 批量操作下拉列表中选择根据所选应用批量下架

    2. 选择应用批量下架对话框中,完成应用选择和设置接口负责人后,单击提交即可。