Swagger注释使用问题

在Spring Boot中使用Swagger2构建RESTful API时
常常需要对API进行文字性描述
其中要用到一些swagger的注解

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

@Api( tags = "")
@Api( description = "")
这个注解标注于类名上方,用于说明整个类的作用;

@ApiOperation( value = "...")
这个注解标注于具体函数上方,用于说明这个函数的作用;

关于入参:
我们常用Get和Post方法
对于Get方法,一般使用@ApiImplicitprams()
对于Post方法,我们一般使用VO进行传参,此时,我们使用注解@@ApiModelProperty(value = "..."),这个注解标注在VO具体的属性中,用来说明这个字段的代表的含义。


Swagger注解位置2.jpg

在使用2.6.1版本的swagger中,遇到的问题:
关于2.6.1版本 tags使用中文描述无法展开接口详情的问题:
//待添加blog
感谢
https://blog.csdn.net/baidu_38609744/article/details/82191029

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容