其中版本最常用2.9.2
springfox提供的@EnableSwagger2注解可以启用swagger2相关技术。该程序将遍历当前类所在的包及其子包中的所有类型，以查找与Swagger相关的注解，并定制Swagger文档
点击try it out可以输入对应的参数查看返回结果
创建Docker类型的对象，并使用spring容器管理。Docker是Swagger中的全局配置对象
使用DocumentationType.SWAGGER_2指定Docket的类对象，以确定使用的是哪个版本
apiInfo()：API文档的描述信息，参数是一个ApiInfo类对象，使用bulid()构建器来创建
contact()：配置swagger文档的主体内容，里面填写也是一个类对象，类对象最多可以三个参数，发布者名称，文档发布者的网站url地址（企业网站），文档发布者的电子邮箱地址
title()：标题 description()：描述信息 .version()：版本信息
对应如下内容
返回ApiSelectorBuilder的方法是select()，用于获取Docker中的选择器。构建选择器。如扫描什么包的注解
apis()：后面是RequestHandlerSelectors的类下的(Predicate)规则，规定扫描那些包的注解，默认是启动类及其子包下的注解
RequestHandlerSelectors类下有几个静态方法（举例三个）
basePackage()：后面填写包名的具体地址，会扫描改包及其子包的注解
any()：为任何接口生成API文档
none()：任何接口都不生成接口文档
path()：使用正则表达式，约束生成Api文档的路径地址，后面填写过滤（通过）的路径
这里没有提及，感兴趣可以自己搜索（留个位置，日后用到了补充）
@Api(常用)
作用：@Api是类上注解。控制整个类生成接口信息的内容
属性：
tags：类的名称。如果有多个值，这意味着有多个副本（别名）可用，SwaggerUI视图将显示哪些控制器可通过哪些访问菜单
description：描述，已过时
@ApiOperation
作用：@ApiOperation是方法上注解，描述方法的相关消息
属性：
value：方法描述作用
notes：方法笔记（展开描述）
@ApiParm
作用：@ApiParm是方法参数的注解。描述该参数
属性：
name：参数名称
value：描述参数作用
required：值为boolean类型，表示该参数是否为必要参数，默认为false
@ApiIgnore
作用：@ApiParm是方法或者参数的注解。忽略注解的方法或者参数，不生成帮助文档
@ApiImplicitParam(常用)
作用：@ApiParm是作用于类上方法，用来描述方法参数的注解。
属性：
name：参数名称，和方法的参数一致
value：参数具体描述
required：值为boolean类型，表示该参数是否为必要参数，默认为false
paramType：参数类型
dataType：数据类型
@ApiImplicitParams
后面跟@ApiImplicitParam的集合，一般用于多个参数的描述
@ApiModel(常用)
作用：@ApiModel是作用于实体类上，描述一个实体类型，整个实体类型如果成为任何一个生成api帮助文档的返回对象的时候，该注解被解析
属性：
value：实体类名称
description：实体类描述
@ApiModelProperty(常用)
作用：@ApiModel是作用于实体类的属性上，描述实体类属性
属性：
value：实体属性描述
name：实体类属性名字，与属性名一致
以上就是SpringBoot项目中怎么使用Swagger2及注解解释的详细内容，更多请关注php中文网其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容，请联系我们，一经查实，本站将立刻删除。
如需转载请保留出处：https://51itzy.com/kjqy/144902.html