BizWorks接口扫描规范

触发接口扫描操作步骤

通过平台扫描接口

1. 登录BizWorks，在选择平台下拉列表中选中微服务开发平台。

2. 单击页面右上角图标或其文本框区域，在下拉列表中单击目标项目名称后，单击应用页签。在应用列表页面单击目标中心应用名称。

3. 在目标中心应用左侧导航栏中，选择应用开发 > 接口管理。

4. 在应用接口管理页面，单击接口扫描。页面右上角为接口扫描上报按钮，左侧显示接口目录树，右侧为接口列表，包含接口名称、Method、Path 等列信息。

5. 在代码扫描上报接口信息面板，单击扫描代码分支。在扫描代码分支面板的代码分支下拉列表中选中目标代码分支后，单击提交。面板中还显示代码库地址和覆盖策略（使用代码接口定义覆盖现有接口定义）信息。

使用BizWorks Toolkit扫描接口

1. 打开IDEA，您可以通过以下两种方式进入接口管理页签。

   • 方式一：在顶部导航栏选择view > Tool Windows > BizWorks > 接口管理。菜单中还包含BizWorks 领域模型、TONGYI Lingma等其他工具窗口选项。

   • 方式二：根据不同版本或主题风格，在左侧边工具栏或底部工具栏单击BizWorks窗口入口后，再单击接口管理页签。面板还包含配置管理和部署管理页签，工具栏中提供增量和全量上报按钮。

2. 可选：接口扫描。

   在接口管理页签的顶部工具栏，单击图标，插件将对当前项目下所有Production范围（不包括 test）的，且符合SpringMVC注解配置的接口进行扫描。

   扫描完成后，接口管理面板中按服务分组显示扫描到的接口，每个接口显示请求方法（如POST）和路径信息。

   扫描结果应与SpringMVC运行时接口范围一致。更多信息，请参见接口扫描规则说明 。

3. 可选：接口上报。单击图标进行增量或全量接口上报。

   • 增量上报：上报新增的接口，更新平台已存在的接口。

   • 全量上报：以本地接口定义为准，覆盖平台接口信息，将删除不存在的接口。

接口扫描规则说明

接口扫描适应于Java语言实现，且遵循SpringMVC注解规范的HTTP接口。

当前支持的框架和库如下：

扫描关系映射示意如下（下图中序列号相同的字段，代表着相应的映射关系）：

API的扫描目前遵循与SpringMVC运行时结果一致的原则，所以仅在Interface中声明的API不会被扫描，需有具体的@Controlle或@RestController实现类。

因为实现类原则上可以实现多个接口，可以覆盖接口中描述的部分信息，故扫描同样从实现类开始，当实现类中缺少对应信息的时候再从超类或接口中寻找。

注释控制

注释控制，指的是通过在类或方法注释中，通过不同的注释tag，控制扫描的行为。示例代码如下：

/**
 * 商品SKU服务
 * @folder 一级目录/二级目录
 */
@RestController("CommoditySkuServiceCON")
public class SkuServiceController implements SkuServiceI {
 ……
}

@folder即为注释的tag，可以改变目录从默认的“商业SKU服务”到“一级目录”/“二级目录” 两级目录下。

当前，所有支持的注释tag如下：