一个我一直以为是Swagger缓存的巨坑,今天终于解决了

最近项目开始使用Swagger作为Api文档的编写工具,Swagger确实是为开发工作带来了很多方便。但是偶尔总会出现明明接口说明已经修改了,但在doc.html上总是看到旧的字段描述。甚至有时字段已经删除了,不管怎么重启,怎么清缓存,还是赖着在那里。

期间一直以为是缓存的问题,各种请浏览器缓存,换浏览器,甚至删除操作系统的tmp目录,都是无法解决。导致这期间总是被前端开发人员说我的接口与文档描述不符。心累啊。

今天无意间打开了“Swagger Models”菜单,发现界面上显示的model数量怎么那么少,跟我服务端的代码的类的数量相差较大。所以去看了一下后端代码,并对比了下“Swagger Models”里面的模型详情。终于被我发现了这个巨坑的根本原因,原来我在定义@ApiModel时写的value值时一样的,Swagger并没有报错,而是默默的帮我把两个类的字段合在一起。代码及效果如下图所示:

UserDto
UserDto的ApiModel的value叫用户Dto

 

User2Dto
User2Dto的ApiModel的value也叫用户Dto

 

效果
结果在Swagger上只有一个用户Dto

 

如上面几个示例图所示,如果两个类的ApiModel命名一样,那就有各种误以为是缓存的问题出现了。如两个类有同一个字段,两个字段的描述不一样,却会出现一个覆盖另一个的问题。有时删除掉一个,因为另一个没有删除,会出现以为删不掉的情况。 

 

 

  • 16
    点赞
  • 14
    收藏
    觉得还不错? 一键收藏
  • 8
    评论
很高兴回答你的问题!下面是集成Swagger的步骤: 1. 添加Swagger依赖 在pom.xml文件中添加以下依赖: ``` <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> ``` 2. 配置Swagger 在项目的配置文件(application.yml或application.properties)中添加以下配置: ``` # Swagger配置 swagger: # 是否启用Swagger,默认为true enabled: true # API文档基础路径 base-package: com.example.demo.controller # API文档标题 title: Demo API # API文档描述 description: Demo API接口文档 # API文档版本号 version: 1.0.0 ``` 3. 创建Swagger配置类 创建一个SwaggerConfig类,用于配置Swagger: ``` @Configuration @EnableSwagger2 public class SwaggerConfig { @Autowired private SwaggerProperties swaggerProperties; @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage(swaggerProperties.getBasePackage())) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title(swaggerProperties.getTitle()) .description(swaggerProperties.getDescription()) .version(swaggerProperties.getVersion()) .build(); } } ``` 4. 启动项目并访问Swagger 启动项目后,在浏览器中访问以下地址即可查看Swagger文档: ``` http://localhost:8080/swagger-ui.html ``` 以上就是Java Spring Boot集成Swagger的步骤,希望能对你有所帮助!

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 8
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值