解决swagger2中@ApiResponse的response不起作用
swagger可以生成比较友好的在线API说明文档
友好的API说明重要性不言而喻，因为所谓API，肯定就是被用来调用的，其中涉及到不同群体的工作，比如前端后端，本公司与第三方公司，等等。以往，制订数据接口，要正正经经地写一份正式的文档，名曰集成规范，大家对照着来。但现在有了swagger框架，就方便许多了，直接利用代码生成在线的接口说明文档。
swagger要产生比较实用的API说明文档，需要加一些标注。但是，这两天在实际应用过程中，却遇到一个问题，即无法生成响应数据的实体类说明。说明部分空空如也。
这样子的话，那么这个API说明文档意义就不大了。因为返回的数据中，有许多字段需要加上中文注释，否则根本不知道什么意思。
我们用的是swagger2
pom.xml
<!-- swagger2 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>3.0.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>3.0.0</version>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.5</version>
</dependency>API所在控制器
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("api/work/production/total")
@Api(tags="产量产值")
public class WorkProductionChangeController {
@Resource
private WorkProductionChangeService workProductionChangeService;
@PostMapping(path = "/all")
@ApiOperation(value = "获取所有年份的总产量产值")
@ApiResponses(value = {
@ApiResponse(code = 200, message = "返回所有年份的总产量产值",response = WorkProductionChange.class)
})
public JSONObject getAll() {
return 。。。
}
}实体类WorkProductionChange
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
@ApiModel
public class WorkProductionChange implements Serializable {
private static final long serialVersionUID = -64757122210615988L;
private Long id;
private Integer year;
@ApiModelProperty(value = "总产量（吨）")
private Double totalWeight;
@ApiModelProperty(value = "总产值（万元）")
private Double totalMoney;
。。。
}按道理，response = WorkProductionChange.class，那么实体WorkProductionChange的信息应该出现在说明文档上，但从效果看，并没有。
狂搜索。后来终于看到有鬼佬说了这么一句：
Springfox 3.0 uses v3 models by default, but source.getResponses() gives wrong type. To workaround it for now, add:
springfox.documentation.swagger.use-model-v3=false in your application.properties.
英文烂，勉强看意思就是说，Springfox3.0默认用swagger v3来返回信息，但有个地方又出毛病了。为了避免愚蠢的系统犯错，你要在配置文件application.properties里加上一句：
application.properties
springfox.documentation.swagger.use-model-v3=false
如果是yml，就是
springfox:
documentation:
swagger:
use-model-v3: false太阳出来了。这才是我想要的。
参考文章：
https://github.com/springfox/springfox/issues/3503
以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。
相关文章
java使用CollectionUtils工具类判断集合是否为空方式
这篇文章主要介绍了java使用CollectionUtils工具类判断集合是否为空方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2022-02-02
这篇文章主要为大家详细介绍了java实现平面山脉模型，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2022-01-01
这篇文章主要介绍了Java遍历Json中的key和value问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教2023-11-11
mybatis-plus是一个 Mybatis 的增强工具,在 Mybatis 的基础上只做增强不做改变,为简化开发、提高效率而生,下面这篇文章主要给大家介绍了关于SpringBoot整合Mybatis-plus案例及用法实例的相关资料,需要的朋友可以参考下2022-12-12
SpringBoot利用ThreadPoolTaskExecutor批量插入百万级数据
在处理大量数据时,为了提高效率和性能,通常需要采用批量插入的方式,本文主要介绍了SpringBoot利用ThreadPoolTaskExecutor批量插入百万级数据,具有一定的参考价值,感兴趣的可以了解一下2024-03-03
这篇文章主要介绍了Java自定义注解用法,结合实例形式总结分析了java常见的自定义注解类型、功能、用法及操作注意事项,需要的朋友可以参考下2019-09-09
这篇文章主要为大家详细介绍了Java HttpURLConnection使用方法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2017-11-11
CORS（Cross-Origin Resource Sharing）是一种允许不同源之间进行资源共享的W3C标准,它通过在服务器端设置特定的HTTP响应头,实现了跨域请求的功能,这种机制要求浏览器和服务器的支持,本文给大家介绍Spring Security中的CORS,感兴趣的朋友一起看看吧2024-10-10
maven目前在web上面的使用方式很普遍，而打包的方式也存在很多方式，本文就详细的介绍了三种方式，具有一定的参考价值，感兴趣的可以了解下2021-06-06
这篇文章主要为大家详细介绍了SpringMVC盗链接详解，具有一定的参考价值，感兴趣的小伙伴们可以参考一下，希望能给你带来帮助2021-07-07
最新评论