解決swagger2中@ApiResponse的response不起作用
swagger可以生成比較友好的在線API說明文檔
友好的API說明重要性不言而喻，因?yàn)樗^API，肯定就是被用來調(diào)用的，其中涉及到不同群體的工作，比如前端后端，本公司與第三方公司，等等。以往，制訂數(shù)據(jù)接口，要正正經(jīng)經(jīng)地寫一份正式的文檔，名曰集成規(guī)范，大家對照著來。但現(xiàn)在有了swagger框架，就方便許多了，直接利用代碼生成在線的接口說明文檔。
swagger要產(chǎn)生比較實(shí)用的API說明文檔，需要加一些標(biāo)注。但是，這兩天在實(shí)際應(yīng)用過程中，卻遇到一個(gè)問題，即無法生成響應(yīng)數(shù)據(jù)的實(shí)體類說明。說明部分空空如也。
這樣子的話，那么這個(gè)API說明文檔意義就不大了。因?yàn)榉祷氐臄?shù)據(jù)中，有許多字段需要加上中文注釋，否則根本不知道什么意思。
我們用的是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="產(chǎn)量產(chǎn)值")
public class WorkProductionChangeController {
@Resource
private WorkProductionChangeService workProductionChangeService;
@PostMapping(path = "/all")
@ApiOperation(value = "獲取所有年份的總產(chǎn)量產(chǎn)值")
@ApiResponses(value = {
@ApiResponse(code = 200, message = "返回所有年份的總產(chǎn)量產(chǎn)值",response = WorkProductionChange.class)
})
public JSONObject getAll() {
return 。。。
}
}實(shí)體類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 = "總產(chǎn)量（噸）")
private Double totalWeight;
@ApiModelProperty(value = "總產(chǎn)值（萬元）")
private Double totalMoney;
。。。
}按道理，response = WorkProductionChange.class，那么實(shí)體WorkProductionChange的信息應(yīng)該出現(xiàn)在說明文檔上，但從效果看，并沒有。
狂搜索。后來終于看到有鬼佬說了這么一句：
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.
英文爛，勉強(qiáng)看意思就是說，Springfox3.0默認(rèn)用swagger v3來返回信息，但有個(gè)地方又出毛病了。為了避免愚蠢的系統(tǒng)犯錯(cuò)，你要在配置文件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
以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。
相關(guān)文章
java使用CollectionUtils工具類判斷集合是否為空方式
這篇文章主要介紹了java使用CollectionUtils工具類判斷集合是否為空方式，具有很好的參考價(jià)值，希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2022-02-02
這篇文章主要為大家詳細(xì)介紹了java實(shí)現(xiàn)平面山脈模型，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2022-01-01
這篇文章主要介紹了Java遍歷Json中的key和value問題,具有很好的參考價(jià)值,希望對大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-11-11
mybatis-plus是一個(gè) Mybatis 的增強(qiáng)工具,在 Mybatis 的基礎(chǔ)上只做增強(qiáng)不做改變,為簡化開發(fā)、提高效率而生,下面這篇文章主要給大家介紹了關(guān)于SpringBoot整合Mybatis-plus案例及用法實(shí)例的相關(guān)資料,需要的朋友可以參考下2022-12-12
SpringBoot利用ThreadPoolTaskExecutor批量插入百萬級數(shù)據(jù)
在處理大量數(shù)據(jù)時(shí),為了提高效率和性能,通常需要采用批量插入的方式,本文主要介紹了SpringBoot利用ThreadPoolTaskExecutor批量插入百萬級數(shù)據(jù),具有一定的參考價(jià)值,感興趣的可以了解一下2024-03-03
這篇文章主要介紹了Java自定義注解用法,結(jié)合實(shí)例形式總結(jié)分析了java常見的自定義注解類型、功能、用法及操作注意事項(xiàng),需要的朋友可以參考下2019-09-09
這篇文章主要為大家詳細(xì)介紹了Java HttpURLConnection使用方法，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2017-11-11
CORS（Cross-Origin?Resource?Sharing）是一種允許不同源之間進(jìn)行資源共享的W3C標(biāo)準(zhǔn),它通過在服務(wù)器端設(shè)置特定的HTTP響應(yīng)頭,實(shí)現(xiàn)了跨域請求的功能,這種機(jī)制要求瀏覽器和服務(wù)器的支持,本文給大家介紹Spring?Security中的CORS,感興趣的朋友一起看看吧2024-10-10
maven目前在web上面的使用方式很普遍，而打包的方式也存在很多方式，本文就詳細(xì)的介紹了三種方式，具有一定的參考價(jià)值，感興趣的可以了解下2021-06-06
這篇文章主要為大家詳細(xì)介紹了SpringMVC盜鏈接詳解，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下，希望能給你帶來幫助2021-07-07