Swagger注釋使用問題

在Spring Boot中使用Swagger2構(gòu)建RESTful API時(shí)
常常需要對(duì)API進(jìn)行文字性描述
其中要用到一些swagger的注解

swagger 2.6.1 
version 1.0
swagger注解位置1.jpg

@Api( tags = "")
@Api( description = "")
這個(gè)注解標(biāo)注于類名上方,用于說明整個(gè)類的作用;

@ApiOperation( value = "...")
這個(gè)注解標(biāo)注于具體函數(shù)上方,用于說明這個(gè)函數(shù)的作用;

關(guān)于入?yún)ⅲ?br> 我們常用Get和Post方法
對(duì)于Get方法,一般使用@ApiImplicitprams()
對(duì)于Post方法,我們一般使用VO進(jìn)行傳參,此時(shí),我們使用注解@@ApiModelProperty(value = "..."),這個(gè)注解標(biāo)注在VO具體的屬性中,用來說明這個(gè)字段的代表的含義。


Swagger注解位置2.jpg

在使用2.6.1版本的swagger中,遇到的問題:
關(guān)于2.6.1版本 tags使用中文描述無法展開接口詳情的問題:
//待添加blog
感謝
https://blog.csdn.net/baidu_38609744/article/details/82191029

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容