Swagger 配置多个接口文档实现和实现多包扫描的配置方式

一、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 配置多个接口文档实现和实现多包扫描的配置方式相关推荐

Swagger 生成 PHP API 接口文档
Swagger 生成 PHP API 接口文档标签(空格分隔): php 1.概况有同学反馈写几十个接口文档需要两天的工作量, 随着多部门之间的协作越来越频繁, 维护成本越来越高, 文档的可维护性 ...
Laravel使用swagger PHP生成api接口文档
Laravel使用swagger PHP生成api接口文档 Swagger集接口文档和测试于一体,就类比将postman和showdoc的结合体首先要先安装基于laravel5的swagger包地 ...
SpringBoot配置swagger-ui可视化接口文档
SpringBoot配置swagger-ui [提前声明] 文章由作者:张耀峰结合自己生产中的使用经验整理,最终形成简单易懂的文章写作不易,转载请注明,谢谢! 代码案例地址: ?https://g ...
php怎么根据接口文档实现功能,CodeIgniter+swagger实现 PHP API接口文档自动生成功能...
一.安装swagger 1.首先需要有composer,没有的自行百度安装 2.下载swagger,打开网站https://packagist.org/packages/zircote/swagger ...
php微信sdk接口文档,php一个文件搞定微信jssdk配置
学习PHP的小伙伴在处理微信jssdk配置的时候可能会遇到一些问题.以下是百分网小编精心为大家整理的php一个文件搞定微信jssdk配置,希望对大家有所帮助!更多内容请关注应届毕业生网! 包括缓存,包 ...
Spring MVC学习总结（9）——Spring MVC整合swagger自动生成api接口文档
Swagger 号称:世界最流行的API框架,官网:http://swagger.io/,Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总 ...
接口文档——Swagger
Swagger 接口文档对于前后端开发人员都十分重要.尤其近几年流行前后端分离后接口文档又变成重中之重.接口文档固然重要,但是由于项目周期等原因后端人员经常出现无法及时更新,导致前端人员抱怨接口 ...
自动生成python接口文档_Django自动生成Swagger接口文档
Django自动生成Swagger接口文档 1. 前言当接口开发完成,紧接着需要编写接口文档.传统的接口文档通常都是使用Word或者一些接口文档管理平台进行编写,但此类接口文档维护更新比较麻烦,每次 ...
SpringCloud Gateway网关统一聚合Swagger接口文档（knife4j），实现通过网关统一文档地址查看所有子服务的接口文档
前言: 在微服务系统中,通常每个服务都会暴露其接口文档,在前端人员或测试人员查看的时候,并不是那么方便,我们需要告诉相关人员每个服务的文档地址,由于swagger/knif4j(knif4j为更易用的 ...

Swagger 配置多个接口文档实现和实现多包扫描的配置方式

一、Swagger 配置多个接口文档实现

二、Swagger 实现多包扫描的配置方式

Swagger 配置多个接口文档实现和实现多包扫描的配置方式相关推荐

最新文章

热门文章

Swagger 配置多个接口文档实现 和 实现多包扫描的配置方式

一、Swagger 配置多个接口文档实现

二、Swagger 实现多包扫描的配置方式

Swagger 配置多个接口文档实现 和 实现多包扫描的配置方式相关推荐

最新文章

热门文章

Swagger 配置多个接口文档实现和实现多包扫描的配置方式

Swagger 配置多个接口文档实现和实现多包扫描的配置方式相关推荐