在Spring Boot中使用Swagger2構(gòu)建RESTful API時(shí)
常常需要對(duì)API進(jìn)行文字性描述
其中要用到一些swagger的注解
swagger 2.6.1
version 1.0
@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è)字段的代表的含義慌申。
在使用2.6.1版本的swagger中陌选,遇到的問題:
關(guān)于2.6.1版本 tags使用中文描述無法展開接口詳情的問題:
//待添加blog
感謝
https://blog.csdn.net/baidu_38609744/article/details/82191029