swagger2配置不生效（swagger的配置）

科技前沿 • 2025-04-22 18:04 • 阅读 54

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

小明今天要跟前端同学对接，发现接口，都是直接同个微信或者发给他，效率很低，而且前端同学也不能测试调用，在对接过程很麻烦，也很费时，他现在很苦恼，大家有什么好的接口文档工具推荐了。

其实现在已经有很多文档对接的工具了，以前使用的是国外的postman，到现在国内的apipost或者apifox等等，或者代码接口集成工具swagger。今天给初入职场的同学们，介绍一下如何整合Swagger以及如何配置指定环境访问。

主要是配置swagger文档扫描的包和方法

讯享网

这里要注意的是，不要在启动类添加@EnableSwagger2，这样会导致整个工程所有接口都生成了swagger文档。

@Api("APP测试接口")：标注接口类，说明改类做什么

@ApiOperation(value = "登录接口", notes = "登录接口")：标注每个方法，说明改接口方法用途

@ApiImplicitParam(name = "name", value = "用户名",required = true, type = "string")：标记方法参数

讯享网

启动项目工程，浏览器访问地址：

http://localhost:端口号/swagger-ui.html#/

点击对应接口，展开进行调试，发现可以正常调用接口

以上基本是完成了swagger的配置了，但是一般项目开发，为了安全起见，会禁止正式环境的访问，或者同个配置中心开启。接下来给大家介绍一下，如何动态设置swagger环境访问。

在SwaggerConfig配置文件类前中添加注解，指定swagger.enable属性，为true，改配置类才生效

讯享网

主application.yaml文件中添加配置环境，这样启动工程就会，springboot就会自动拼接：application-dev.yaml、application-test.yaml、application-pro.yaml，然后根据profiles配置读取对应的配置文件，

新建不同环境的application.yaml文件，后缀由dev、test、pro

application-dev.yaml配置swagger为true

讯享网

application-pro.yaml配置swagger为false

其实有两种方式进行修改

一种是直接通过配置中心动态修改，项目部署上线之后，想要在在正式环境访问的话，直接修改application-pro.yaml配置swagger为true。

另一种就是同个maven构建打包的时候，自动切换读取对应的配置文件

本文主要讲了如何配置swagger接口文档，以及如何控制不同环境访问，一般开发，根据个人经验，除非新工程，才需要配置swagger，不然都是已经大佬搭建好了，我们只要熟悉使用swagger相关注解，按照规范进行定义接口。不过控制不同环境访问，这个是我工作中遇到的，很多大佬搭建的时候，都没在意，而且网上方法也是参差不齐，

swagger2配置不生效（swagger的配置）

相关推荐