如何在Spring Boot 项目中使用swagger-ui?

2025-11-05 19:40:43

1、首先打开一个maven 管理的spring boot 项目,至于怎么创建Spring Boot项目,不在此讨论范围内。

如下图,一个标准结构的maven项目。

如何在Spring Boot 项目中使用swagger-ui?

2、然后是引入依赖。

在pom.xml文件的dependencies分支里,添加swagger-ui的依赖。

如下图,注意放的位置要在dependencies里面。

附代码:

        <!-- swagger ui -->

        <dependency>

            <groupId>io.springfox</groupId>

            <artifactId>springfox-swagger2</artifactId>

            <version>2.2.2</version>

        </dependency>

如何在Spring Boot 项目中使用swagger-ui?

3、接下来,在代码中通过注解方式引入。

注意红框内的两个注解,既是swagger-ui的注解。

如何在Spring Boot 项目中使用swagger-ui?

4、接着就可以启动项目了。

注意端口,这是在属性文件配置的。

如何在Spring Boot 项目中使用swagger-ui?

5、红框内,可以看到项目成功启动了。

如何在Spring Boot 项目中使用swagger-ui?

6、通过浏览器打开swagger-ui的web管理界面。

默认地址是IP:port/swagger-ui.html.

本地运行IP是127.0.0.1,port即是第四部的端口。

如何在Spring Boot 项目中使用swagger-ui?

7、可以看到接口列表,可以使用了。

如何在Spring Boot 项目中使用swagger-ui?

声明:本网站引用、摘录或转载内容仅供网站访问者交流或参考,不代表本站立场,如存在版权或非法内容,请联系站长删除,联系邮箱:site.kefu@qq.com。
猜你喜欢