Swagger @Example與@ExampleProperty使用無(wú)效原因分析
更新時(shí)間：2026年03月11日 09:27:45 作者：很倔也很天真
Swagger@Example與@ExampleProperty無(wú)效的原因是Swagger默認(rèn)UI不支持顯示這些配置,即使后端返回的數(shù)據(jù)中有配置的內(nèi)容
Swagger @Example與@ExampleProperty使用無(wú)效
code string example: 123321 驗(yàn)證碼 password string example: pwd123456 密碼 phone string example: 13633731313 手機(jī)號(hào) username string example: account1001 用戶名
@ApiImplicitParams(
@ApiImplicitParam(name = "form", value = "手機(jī)登錄表單",
examples = @Example(
@ExampleProperty(value = "{\"code\": 123321,\"phone\": \"13633731313\"}", mediaType = "application/json")
))
)
預(yù)想顯示結(jié)果
{
"code": 123321,
"phone": 13633731313
}
但Swagger默認(rèn)UI只會(huì)顯示
{
"code": 123321,
"password": "pwd123456",
"phone": 13633731313,
"username": "account1001"
}
原因是UI不支持顯示
但后端返回?cái)?shù)據(jù)中有配置的內(nèi)容
參照沒有使用配置的接口可以發(fā)現(xiàn)，當(dāng)他發(fā)現(xiàn)有實(shí)體的時(shí)候就直接使用實(shí)體中的描述來(lái)顯示了。
總結(jié)
以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。
相關(guān)文章
使用Feign遠(yuǎn)程調(diào)用時(shí),序列化對(duì)象失敗的解決
這篇文章主要介紹了使用Feign遠(yuǎn)程調(diào)用時(shí),序列化對(duì)象失敗的解決方案，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-07-07
這篇文章主要介紹了springboot下使用mybatis的方法,需要的朋友可以參考下2017-11-11
java+jdbc+mysql+socket搭建局域網(wǎng)聊天室
這篇文章主要為大家詳細(xì)介紹了java+jdbc+mysql+socket搭建局域網(wǎng)聊天室，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2019-01-01
這篇文章主要介紹了spring boot mybatis全注解化的相關(guān)資料,需要的朋友可以參考下2017-09-09
Maven編譯遇到Process terminated問題(四種情況全部解決)
這篇文章主要介紹了Maven編譯遇到Process terminated問題(四種情況全部解決),具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-07-07
SpringBoot應(yīng)用中,調(diào)用外部接口是微服務(wù)架構(gòu)常見需求,本文主要介紹了SpringBoot調(diào)用外部接口的幾種方式,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2024-10-10
ScheduledExecutorService任務(wù)定時(shí)代碼示例
這篇文章主要介紹了ScheduledExecutorService任務(wù)定時(shí)代碼示例，具有一定借鑒價(jià)值,需要的朋友可以參考下2018-01-01
SpringBoot使用EmbeddedDatabaseBuilder進(jìn)行數(shù)據(jù)庫(kù)集成測(cè)試
在開發(fā)SpringBoot應(yīng)用程序時(shí)，我們通常需要與數(shù)據(jù)庫(kù)進(jìn)行交互，為了確保我們的應(yīng)用程序在生產(chǎn)環(huán)境中可以正常工作，我們需要進(jìn)行數(shù)據(jù)庫(kù)集成測(cè)試，在本文中，我們將介紹如何使用 SpringBoot 中的 EmbeddedDatabaseBuilder 來(lái)進(jìn)行數(shù)據(jù)庫(kù)集成測(cè)試2023-07-07
這篇文章主要介紹了Java設(shè)計(jì)模式—觀察者模式，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2019-03-03
這篇文章主要為大家詳細(xì)介紹了如何實(shí)現(xiàn)nacos的配置的熱更新,文中的示例代碼講解詳細(xì),具有一定的借鑒價(jià)值,感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2023-12-12