Knife4j是一款基于Swagger 2的在線API文檔框架。

基本使用:

1.在項目中添加依賴

注意：以上依賴項僅適用于Spring Boot 2.6（不含）之前的版本。

在配置文件中開啟增強(qiáng)模式 ,在`application.properties`中添加：

自定義配置類，實現(xiàn)必要的配置:

創(chuàng)建`Knife4jConfiguration`，并添加配置：?提示：以下配置代碼是相對固定的。

使用:

????打開瀏覽器，輸入 http://localhost:8080/doc.html 即可訪問。

詳細(xì)配置:

在控制器類上添加`@Api`注解，配置`tags`屬性，可以指定模塊名稱（API文檔中的一級菜單中顯示的名稱）

在處理請求的方法上添加`@ApiOperation`注解，配置`value`屬性，可以指定業(yè)務(wù)名稱（API文檔中的一級菜單的子項顯示的名稱）

在處理請求的方法上添加`@ApiOperationSupport`注解，配置`order`屬性，取值為數(shù)值，可以指定業(yè)務(wù)的顯示排序序號，將根據(jù)`order`屬性值升序排列

在處理請求的方法的POJO參數(shù)的屬性上添加`@ApiModelProperty`注解，配置`value`屬性，可以指定參數(shù)的說明，另外，還可以通過此注解的`required`屬性配置此參數(shù)是否必須（并不具備檢查功能，只是在API文檔上顯示為必須提交）