文档

BizWorks Toolkit如何触发接口扫描、上报平台和管理接口

更新时间:

本文介绍BizWorks Toolkit如何触发接口扫描、上报平台和管理接口。

背景信息

在IDE与BizWorks平台的接口开发过程中涉及到的环节如下图所示,红色边框部分为BizWorks Toolkit需要覆盖支持的便捷操作,红色边框且背景填充色为红色的节点为BizWorks Toolkit接口管理和操作相关的功能。1

BizWorks Toolkit覆盖API的配置(API分组)、API扫描并上报平台。

说明

接口扫描时,如果您在配置文件里配置了server.servlet.context-path,需要设置Registry.. keybizworks.api.scan.contextPath的值为true

触发接口扫描和上报平台

  • 接口信息扫描:扫描指定的文件或文件夹下所有的接口信息,并在BizWorks接口管理中展示和管理。1

  • 接口信息扫描后上报平台:扫描指定的文件或文件夹下所有的接口信息,而后上报信息到BizWorks平台,并在BizWorks接口管理中展示和管理。

触发接口扫描与上报平台:在Toolwindow的菜单中选择上报所有接口信息平台1

管理接口

下图为BizWorks接口管理的Toolwindow页面。Toolwindow由左右两部分组成,下文将对这两部分进行详细说明。1

  • 左侧窗口中的名称为工程扫描出的接口分组与接口名称,您可以在窗口顶部触发全工程扫描(单击1图标)或上报所有接口信息平台(单击1图标)的操作。

  • 在左侧窗口双击目标接口名称,则会打开并展示对应controller类,鼠标定位在对应的接口上。

  • 在左侧窗口单击目标接口名称,则会在右侧窗口展示对应接口的详细信息,信息包括但不限于:接口名称、接口method、接口URL、接口入参、接口返回信息、接口分组。