一、Swagger 配置多個接口文檔實現

場景說明：在一個項目中，后臺接口分為后端后臺接口和小程序端接口，為了方便區分，希望將2種不同的接口分開展示。

在做當前配置之前，首先你得先配置好基礎的swagger配置，并且能夠訪問swagger的swagger-ui的頁面。 http://localhost:8080/swagger-ui/index.html，如下：

然后，在你的swagger配置中，copy一份 @Bean 的注解的方法，將 .groupName(GROUP_NAME_ADMIN) 的參數名稱修改，使其和之前的不一樣就行。如下代碼：

/*** 創建API*/@Beanpublic Docket createRestApi() {return new Docket(DocumentationType.OAS_30).groupName(GROUP_NAME_ADMIN)// 是否啟用Swagger.enable(enabled)// 用來創建該API的基本信息，展示在文檔的頁面中（自定義展示的信息）.apiInfo(apiInfo())// 設置哪些接口暴露給Swagger展示.select()// 掃描所有有注解的api，用這種方式更靈活.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))// 掃描指定包中的swagger注解 e.g com.ruoyi.project.tool.swagger.apis(RequestHandlerSelectors.basePackage("com.mrcy.wechat"))// 掃描所有 .apis(RequestHandlerSelectors.any()).paths(PathSelectors.any()).build()/* 設置安全模式，swagger可以設置訪問token */.securitySchemes(securitySchemes()).securityContexts(securityContexts()).pathMapping(pathMapping);}@Beanpublic Docket createWxRestApi() {return new Docket(DocumentationType.OAS_30).groupName(GROUP_NAME_WX_API)// 是否啟用Swagger.enable(enabled)// 用來創建該API的基本信息，展示在文檔的頁面中（自定義展示的信息）.apiInfo(apiInfo())// 設置哪些接口暴露給Swagger展示.select()// 掃描所有有注解的api，用這種方式更靈活.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))// 掃描指定包中的swagger注解 e.g com.ruoyi.project.tool.swagger.apis(RequestHandlerSelectors.basePackage("com.mrcy.web").or(RequestHandlerSelectors.basePackage("com.mrcy.common.core.domain")))// 掃描所有 .apis(RequestHandlerSelectors.any()).paths(PathSelectors.any()).build()/* 設置安全模式，swagger可以設置訪問token */.securitySchemes(securitySchemes()).securityContexts(securityContexts()).pathMapping(pathMapping);}

二、Swagger 實現多包掃描的配置方式

場景說明：在一個項目中，子模塊隨處可見，很可能你需要的某一個類在common中，但是你當前swagger的掃描并不能支持掃描到，所以就需要配置多包掃描。

具體代碼已經在上面體現，即是下面這一部分：

.apis(RequestHandlerSelectors.basePackage("com.mrcy.web").or(RequestHandlerSelectors.basePackage("com.mrcy.common.core.domain")))

值得注意的是使用的 or 連接。

總結

以上是生活随笔為你收集整理的Swagger 配置多个接口文档实现 和 实现多包扫描的配置方式的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。