springboot引入swagger - 穆世明博客

号称世界上最流行的API框架
Restful Api 文档在线自动生成器 => API 文档与API 定义同步更新
直接运行，在线测试API
支持多种语言（如：Java，PHP等）
Swgger官网：https://swagger.io/

HelloWord.java

SwaggerConfig.java

浏览器输入：http://localhost:8080/swagger-ui.html
在这里插入图片描述

SwaggerConfig.java

在这里插入图片描述

通过Docket.select()配置怎么扫描

序号方法说明1RequestHandlerselectors配置要扫描接口的方式2basePackage指定要扫描的包3any扫描全部4none()不扫描5withClassAnnotation扫描类上的注解，多数是一个注解的反射对象6withMethodAnnotation扫描方法上的注解7paths过滤，只看到过滤的接口8enable是否开启swagger，默认为true9regex正则表达式10ant通过ant()控制

在这里插入图片描述

配置是否启用Swagger，如果是false，在浏览器将无法访问

application.properties切换环境

在这里插入图片描述
SwaggerConfig.java

在这里插入图片描述

关闭swagger2使用显示页面：
在这里插入图片描述

如果没有配置分组，默认是default。
在这里插入图片描述

在这里插入图片描述

一个Docket对应一个分组

在这里插入图片描述

只要我们的接口中，返回值中存在实体类，他就会被扫描到Swagger中

User.java

在这里插入图片描述
注：并不是因为@ApiModel这个注解让实体显示在这里了，而是只要出现在接口方法的返回值上的实体都会显示在这里，而@ApiModel和@ApiModelProperty这两个注解只是为实体添加注释的。

@ApiModel为类添加注释

@ApiModelProperty为类属性添加注释

@@ApiOperation为方法添加注释

Swagger注解简单说明@Api(tags = “xxx模块说明”)作用在模块类上@ApiOperation(“xxx接口说明”)作用在接口方法上@ApiModel(“xxxPOJO说明”)作用在模型类上：如VO、BO@ApiModelProperty(value = “xxx属性说明”,hidden = true)作用在类方法和属性上，hidden设置为true可以隐藏该属性@ApiParam(“xxx参数说明”)作用在参数、方法和字段上，类似@ApiModelProperty

在这里插入图片描述
2、bootstrap-ui 访问 http://localhost:8080/doc.html

在这里插入图片描述
3、Layui-ui 访问 http://localhost:8080/docs.html

在这里插入图片描述
4、mg-ui 访问 http://localhost:8080/document.html

在这里插入图片描述
内容参考：https://blog.csdn.net/_/article/details/

上一篇：程序设计基础c语言知识点

下一篇：分词器有哪些

版权声明：
本文来源网络，所有图片文章版权属于原作者，如有侵权，联系删除。

本文网址：https://www.mushiming.com/mjsbk/11632.html

相关文章：