觸發接口掃描操作步驟

通過平臺掃描接口

1. 登錄BizWorks，在選擇平臺下拉列表中選中微服務開發平臺。

2. 單擊頁面右上角圖標或其文本框區域，在下拉列表中單擊目標項目名稱后，單擊應用頁簽。在應用列表頁面單擊目標中心應用名稱。

3. 在目標中心應用左側導航欄中，選擇應用開發 > 接口管理。

4. 在應用接口管理頁面，單擊接口掃描。

5. 在代碼掃描上報接口信息面板，單擊掃描代碼分支。在掃描代碼分支面板的代碼分支下拉列表中選中目標代碼分支后，單擊提交。

使用BizWorks Toolkit掃描接口

1. 打開IDEA，您可以通過以下兩種方式進入接口管理頁簽。

   • 方式一：在頂部導航欄選擇view > Tool Windows > BizWorks > 接口管理。

   • 方式二：根據不同版本或主題風格，在左側邊工具欄或底部工具欄單擊BizWorks窗口入口后，再單擊接口管理頁簽。

2. 可選：接口掃描。

   在接口管理頁簽的頂部工具欄，單擊圖標，插件將對當前項目下所有Production范圍（不包括 test）的，且符合SpringMVC注解配置的接口進行掃描。

   

   掃描結果應與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如下：