升级swagger3.0

时间:2025-03-18 09:05:15

swagger的版本都是需要导入两个依赖包的,而3.0仅需要导入一个依赖,据说这是swagger社区整合的,但是个人感觉还不错,因为已经停更了。

所以本人就对系列进行升级,过程还是挺简单的。

首先注释掉原本的两个依赖,然后导入新的依赖。

<dependency>
    <groupId></groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

把原本的SwaggerConfig复制改成Swagger3Config,以防万一我一般都不直接删除,直到确认无误了才删掉。

将SwaggerConfig的几个注解都注释掉,包括@Configuration,@EnableSwagger2,@Bean,省去spring生成。

//@Configuration
//@EnableSwagger2
@Slf4j
public class SwaggerConfig {
	//@Bean
	...
}

然后开始改Swagger3Config,将EnableSwagger2改成EnableOpenApi,将new Docket的DocumentationType,由SWAGGER_2改成OAS_30。

@Configuration
@EnableOpenApi
@Slf4j
public class Swagger3Config {
	@Bean
    public Docket createRestApi(Environment environment) {
        // 设置要显示swagger的环境
        // 判断当前是否处于该环境
        (hostAddress);
        boolean b = (("dev", "local"));

        return new Docket(DocumentationType.OAS_30)
        	...
        }
    }

修改成功后,如果你不想去多写一个mvc的话,需要改一下swagger的地址,本来是要改成swagger-ui/即可
如下

旧:
http://localhost:8009/api/iStudy/
新:
http://localhost:8009/api/iStudy/swagger-ui/

这样基本的swagger就升级完成了,可以基本的使用了,有需要更多功能的,自己再去多瞅瞅