项目中梳理——Springboot整合Swagger-优快云博客

本文链接：https://blog.youkuaiyun.com/Hathwayoung/article/details/105722101

本文详细介绍了如何在SpringBoot项目中整合Swagger，实现在线API文档的快速编写与更新。通过引入Swagger依赖，创建Docket Bean并配置参数，即可在本地运行环境中访问到完整的API文档界面。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

在前后端分离的项目中，目前业内普遍选择的是使用Swagger实现在线API文档的功能，它可以帮助我们快速编写最新的API接口文档，并且有效减少沟通维护的成本。Swagger官网中对于它的介绍是——API Development，从字词中我们就可以知道它的用途，swagger-ui提供了一个功能齐全的图形化界面。
那么，如何用Springboot整合swagger为我们所用呢？

1.引入swagger依赖

在pom.xml中引入swagger依赖（用maven完成）。

<!-- swagger -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.2.2</version>
</dependency>

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.2.2</version>
</dependency>

2.进入SwaggerConfig方法

创建一个Docket的Bean，并enable swagger。

@Configuration
public class SwaggerConfig {
    //是否开启swagger，根据环境来选择
    @Value(value = "${swagger.enabled}")
    Boolean swaggerEnabled;

在这里插入图片描述
这里需要注意，basePackage很重要，它的包路径=一般Controller的路径。

其他的配置如赋放行权限就不用说了，之前有类似总结。
然后进入URLhttp://localhost:8080/swagger-ui.html就可以看到swagger的界面啦！

最后，推荐可做参考的文章：https://www.jianshu.com/p/7e543f0f0bd8