实验:上架开放平台能力

更新时间:
复制为 MD 格式

中心应用在环境中部署成功后,BizWorks将会自动将此版本的信息同步到开放平台中。本文介绍如何上架开放平台能力。

上架接口

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

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

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

    说明

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

    页面左侧提供业务视角应用视角两个页签用于切换分类视图,下方为业务分类树形菜单。右侧上方为搜索筛选区,支持按接口名称/Path上架状态环境类型进行检索,右上角可进行批量操作。下方接口列表展示接口名称、Method、Path、上架状态、环境类型、所属项目、所属应用、最后更新时间等信息,操作列提供编辑下架功能。

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

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

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

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

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

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

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

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

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

    说明

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

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

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

      如果接口没有相应负责人信息,则需在接口上架对话框中,完成接口负责人设置后,单击提交。在弹出的 接口上架 对话框中,选择 接口负责人,然后单击 提交

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

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

      2. 根据所选能力批量上架对话框中,设置接口负责人后,单击提交。在弹出的对话框中,设置 接口负责人,然后单击 提交

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

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

      2. 选择应用批量上架对话框中,完成应用选择和设置接口负责人后,单击提交即可。在弹出的 选择应用批量上架 对话框中,选择 选择应用 并指定 接口负责人,然后单击 提交

新建能力产品

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

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

  3. 能力产品管理页面,单击新建能力产品

  4. 能力产品面板,完成相关配置项设置后,单击创建。面板分为基本信息和起始版本信息两部分,带星号(*)的为必填项。

    配置项

    说明

    能力产品名称

    自定义一个能力产品名称。名称长度不得超过100个字符。

    编码

    英文字母和数字的组合,以大写字母开头,且项目内唯一,创建后不支持修改。编码长度不得超过80个字符。

    描述

    能力产品描述信息,非必填。描述长度不得超过255个字符。

    能力产品负责人

    能力产品负责人下拉列表中,选择目标能力产品负责人,支持多选。

    能力产品所属目录

    您可以为新建的能力产品选择所属目录。

    起始版本号

    创建能力产品后,系统将自动创建一个草稿状态的能力产品版本。你可以在该版本内继续编辑能力产品内容。

    默认值v1。

    起始版本描述

    起始版本描述信息,非必填。

    创建完成后,您可以在能力产品列表查看所建的能力产品。列表中展示各能力产品的编码最新版本上架状态最后更新描述等信息,操作列提供编辑属性删除入口。

上架能力产品

  1. 能力产品管理页面,单击目标能力产品名称。

  2. 在目标能力产品名称版本列表,单击目标版本号右侧操作列下的上架

  3. 在二次确认对话框中,单击确定

设置能力目录和能力地图

设置能力目录

能力目录可用于对能力产品和基础能力进行分类,便于业务方快速查找。示例项目已经预置了用户商品交易三个目录节点,您可以手动添加新的目录节点。

具体操作,请参见构建能力目录

设置能力地图

示例项目预置了三个业务参与方,商家、平台、消费者。业务参与方指的是平台所支撑的前台业务的参与方,用于关联所需呈现的能力目录,构建能力地图。这样便于业务方根据能力地图从自身视角出发快速找到所需的能力产品。

具体操作,请参见以下文档:

定制官网内容

门户定制页面,示例项目已为您预置好了官网发布所需填写的内容,您可以根据需要对内容进行调整,完成后单击保存即可。具体操作,请参见定制官网内容

访问能力开放门户

发布官网

  1. 开放设置页面,开启开放门户页面设置开关。

  2. 门户定制页面,单击页面右上角的发布,完成示例项目官网的对外发布操作。

访问官网

在完成官网发布后,单击前往能力开放门户即可访问平台官网。