本文详细介绍了Swagger中常用的注解，包括@Api、@ApiModel、@ApiOperation、@ApiModelProperty、@ApiImplicitParam、@ApiImplicitParams、@ApiParam的使用方法和参数含义，帮助开发者更好地创建和理解API文档。特别强调了@ApiModelProperty中的example属性配置，指出以特殊字符开头时需要转义的规则，以便正确生成JSON格式的文档。
常用注解
@Api 标识一个java类型是文档类，用controller类的类名上
@ApiModel 表示一个实体类/模型文档，用在类名上；
@ApiModelProperty 作用在属性上，添加属性描述；
@ApiOperation 作用在接口类的方法上，控制方法的相关描述；
@ApiImplicitParam 作用在接口方法上，描述单个参数信息，只能作用在方法上；
@ApiImplicitParams 作用在接口方法上，@ApiImplicitParam参数组；
@ApiParam 作用在接口方法上，描述单个参数信息，属性基本与@ApiImplicitParam一样，但可以作用在方法、参数、属性上；
下面分别对每个注解的常用参数作讲解。
@Api：
value：字符串，对controller类的作用描述，代替原来的description（已过时），一般用此属性；
tags：字符串数组，标签组，同样可以描述controller的作用；
@ApiModel
value：字符串，模型的简短别名，使得在文档的导航中便于识别；
description：字符串，模型的附加描述；
最低0.47元/天 解锁文章
扫一扫
3382
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
