SpringBoot项目中怎么使用Swagger2及注解解释


本文小编为大家详细介绍“SpringBoot项目中怎么使用Swagger2及注解解释”,内容详细,步骤清晰,细节处理妥当,希望这篇“SpringBoot项目中怎么使用Swagger2及注解解释”文章能帮助大家解决疑惑,下面跟着小编的思路慢慢深入,一起来学习新知识吧。其中版本最常用2.9.2@EnableSwagger2是springfox提供的一个注解,代表swagger2相关技术开启。会扫描当前类所在包,及子包中所有类型的swagger相关注解,做swagger文档的定制
点击try it out可以输入对应的参数查看返回结果创建Docker类型的对象,并使用spring容器管理。Docker是Swagger中的全局配置对象DocumentationType.SWAGGER_2:给Docket一个类对象,知道是那一个版本的apiInfo():API文档的描述信息,参数是一个ApiInfo类对象,使用bulid()构建器来创建contact():配置swagger文档的主体内容,里面填写也是一个类对象,类对象最多可以三个参数,发布者名称,文档发布者的网站url地址(企业网站),文档发布者的电子邮箱地址title():标题 description():描述信息 .version():版本信息对应如下内容select(免费云主机域名):获取Docker中的选择器,返回ApiSelectorBuilder。构建选择器。如扫描什么包的注解apis():后面是RequestHandlerSelectors的类下的(Predicate)规则,规定扫描那些包的注解,默认是启动类及其子包下的注解RequestHandlerSelectors类下有几个静态方法(举例三个)basePackage():后面填写包名的具体地址,会扫描改包及其子包的注解any():为任何接口生成API文档none():任何接口都不生成接口文档path():使用正则表达式,约束生成Api文档的路径地址,后面填写过滤(通过)的路径这里没有提及,感兴趣可以自己搜索(留个位置,日后用到了补充)作用:@Api是类上注解。控制整个类生成接口信息的内容属性:tags:类的名称。可以有多个值,多个值表示多个副本(别名),有几个别名在swaggerui视图上显示几个控制器访问菜单description:描述,已过时作用:@ApiOperation是方法上注解,描述方法的相关消息属性:value:方法描述作用notes:方法笔记(展开描述)作用:@ApiParm是方法参数的注解。描述该参数属性:name:参数名称value:描述参数作用required:值为boolean类型,表示该参数是否为必要参数,默认为false作用:@ApiParm是方法或者参数的注解。忽略注解的方法或者参数,不生成帮助文档作用@ApiParm是作用于类上方法,用来描述方法参数的注解。属性:name:参数名称,和方法的参数一致value:参数具体描述required:值为boolean类型,表示该参数是否为必要参数,默认为falseparamType:参数类型dataType:数据类型后面跟@ApiImplicitParam的集合,一般用于多个参数的描述作用@ApiModel是作用于实体类上,描述一个实体类型,整个实体类型如果成为任何一个生成api帮助文档的返回对象的时候,该注解被解析属性:value:实体类名称description:实体类描述作用@ApiModel是作用于实体类的属性上,描述实体类属性属性:value:实体属性描述name:实体类属性名字,与属性名一致读到这里,这篇“SpringBoot项目中怎么使用Swagger2及注解解释”文章已经介绍完毕,想要掌握这篇文章的知识点还需要大家自己动手实践使用过才能领会,如果想了解更多相关内容的文章,欢迎关注百云主机行业资讯频道。

相关推荐: 怎么用GAN训练自己数据生成新的图片

本文小编为大家详细介绍“怎么用GAN训练自己数据生成新的图片”,内容详细,步骤清晰,细节处理妥当,希望这篇“怎么用GAN训练自己数据生成新的图片”文章能帮助大家解决疑惑,下面跟着小编的思路慢慢深入,一起来学习新知识吧。可以看到,datasets.MNIST这个…

免责声明:本站发布的图片视频文字,以转载和分享为主,文章观点不代表本站立场,本站不承担相关法律责任;如果涉及侵权请联系邮箱:360163164@qq.com举报,并提供相关证据,经查实将立刻删除涉嫌侵权内容。

Like (0)
Donate 微信扫一扫 微信扫一扫
Previous 06/12 17:50
Next 06/12 17:56

相关推荐