swagger2配置security（swagger2config）

科技前沿 • 2025-05-06 12:35 • 阅读 68

大家好，我是讯享网，很高兴认识大家。

放弃Springfox，追随Springdoc

概述
快速开始

1、添加依赖
2、启动项目，查看OpenAPI3.0的json文件
3、修改默认/v3/api-docs的访问路径
4、集成SwaggerUI
5、修改默认访问地址
6、启用分组配置

示例代码

1、配置类OpenApiConfig.java
2、创建2个不同的包，用来模拟多个微服务
3、application.properties配置
4、定义一个Controller的公共Response对象R.java
5、自定义异常类CustomException.java
6、统一异常处理类GlobalControllerExceptionHandler.java
7、Book包Controller类BookController.java
8、Book包DTO类BookDTO.java
9、Book包VO类BookVO.java
10、Store包Controller类StoreController.java
11、Store包DTO类StoreDTO.java
12、Store包VO类StoreVO.java

附录：Swagger2转Swagger3注解说明
项目Github地址

由于Springfox在2017年的时候就停更了，现在公司也正好想升级一下RestAPI，目前我们用的是Springfox的swagger2，本来想偷懒直接升级成Springfox的swagger3，但是最终失败了，页面一直加载不出接口，不知道什么原因，google了一圈都没找到答案，无奈放弃Springfox，转用Springdoc了。

1、添加依赖

项目pom.xml中添加依赖

2、启动项目，查看OpenAPI3.0的json文件

3、修改默认/v3/api-docs的访问路径

修改

修改后，可以通过下面的地址访问：

讯享网

效果跟第2步是一样的

4、集成SwaggerUI

通过下面的地址访问

5、修改默认访问地址

修改

修改后，可以通过下面的地址访问：

效果跟第4步是一样的，这个地址并不是真正被修改，最终地址还是被重定向到但是你不能直接访问这个地址，否则会展示OpenAPI3.0的演示UI页面，如下图所示：

使用springsecurity 导致openfeign接口调不通 springdoc openapi_html

6、启用分组配置

访问

使用springsecurity 导致openfeign接口调不通 springdoc openapi_html_02

1、配置类

2、创建2个不同的包，用来模拟多个微服务

使用springsecurity 导致openfeign接口调不通 springdoc openapi_java_03

swagger2配置security（swagger2config）

放弃Springfox，追随Springdoc

1、添加依赖

2、启动项目，查看OpenAPI3.0的json文件

3、修改默认/v3/api-docs的访问路径

4、集成SwaggerUI

5、修改默认访问地址

6、启用分组配置

1、配置类

2、创建2个不同的包，用来模拟多个微服务

3、配置

4、定义一个Controller的公共Response对象

5、自定义异常类

6、统一异常处理类

7、Book包Controller类

8、Book包DTO类

9、Book包VO类

10、Store包Controller类

11、Store包DTO类

12、Store包VO类

相关推荐