swagger2 配置(swagger2使用教程)

swagger2 配置(swagger2使用教程)svg xmlns http www w3 org 2000 svg style display none svg

大家好,我是讯享网,很高兴认识大家。



 <svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> <path stroke-linecap="round" d="M5,0 0,2.5 5,5z" id="raphael-marker-block" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></path> </svg> <p></p> 

讯享网

这里使用SpringBoot整合Swagger。

首先使用这个工具,我们就要有它的依赖包吧,这里使用maven的方式导入jar包。
这里提供一个maven下载jar包的工具
链接: https://mvnrepository.com/


讯享网

讯享网

在这里插入图片描述

建一个config配置文件,SwaggerConfig
这里需要介绍两个注解
注解表示这是一个配置类,也就是说当程序运行时,就会被加载。
这个注解是Swagger的特有注解,表示是Swagger的配置。
在这里插入图片描述

在启动项目是报了一个错误,嗯,,,,解决下这个报错,在继续
在这里插入图片描述
原因分析:一看就是什么版本问题了,应该是我的jdk版本和配置的发行版本不一致吧!!
在这里插入图片描述
但是我配置了也没有用,结果是自己挖的坑,我的pom文件配置的jdk是17,,,
在这里插入图片描述
改成8之后,还是报错,就是换了一个不同的报错信息,额,,,,
在这里插入图片描述
这个报错就是springBoot的版本太高了,降下版本就可以启动成功了!!!
在这里插入图片描述
从这里就可以看到springboot框架整合了tomcat服务器,默认端口8080,我们浏览器访问测试一下swagger
在这里插入图片描述

上面的测试都是swagger的默认配置,在项目开发中都有自己的项目名称之类的,接下来配置自己的相关信息!!

需要创建一个Docket对象,以及ApiInfo的信息
看下ApiInfo对象的构造参数的源码
定义了标题,描述,版本,作者个人信息等等。
在这里插入图片描述
在这里插入图片描述
但是如果我们不想让生产环境看到我们的接口文档,就需要配置项目的环境,激活dev环境
在这里插入图片描述
在application.properties文件激活dev环境,

此时,我们再访问8080的端口时,就会报网页找不到,但是8081就可以访问得到了
8080在这里插入图片描述
8081

在这里插入图片描述

 

常用的三个注解

@Api用于类上
@ApiModelProperty用于实体类的属性上
@ApiOperation用于方法上

这里我建了一个User对象类,用于测试
使用了lombook插件,自动获取
在这里插入图片描述
重新建一个Controller,UserController类用于测试
在这里插入图片描述

再重启服务,浏览器调用swagger,就可以看到效果啦!!!
通过重启项目,我们也可以看到激活的环境,以及相应的端口信息
在这里插入图片描述
在这里插入图片描述
浏览器访问一下getUser这个方法看看结果
在这里插入图片描述

总结:注意注意版本控制呀!!!不然都是自己找的坑!!!

小讯
上一篇 2025-05-09 20:55
下一篇 2025-06-05 16:27

相关推荐

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容,请联系我们,一经查实,本站将立刻删除。
如需转载请保留出处:https://51itzy.com/kjqy/139911.html