springboot项目整合swagger2

最新推荐文章于 2024-08-24 08:59:23 发布

置顶

m1234ilu

最新推荐文章于 2024-08-24 08:59:23 发布

阅读量324

点赞数

分类专栏： Spring注解

本文链接：https://blog.csdn.net/m1234ilu/article/details/106392177

版权

本文介绍了如何在SpringBoot项目中集成Swagger2，包括在pom.xml中引入依赖，配置Swagger，编写Controller，以及使用Swagger提供的注解进行API文档说明。同时提到了访问Swagger UI的地址，并提醒注意Swagger需要的API权限以及遇到模板问题时的解决办法。

摘要由CSDN通过智能技术生成

springBoot项目整合Swagger2

官方地址：https://swagger.io/

swagger版本号：2.9.2

springBoot 2.1.6

jdk 1.8

第一步：在pom.xml文件中引入jar包

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

       <!-- 先引入下，以防本地仓库没有，后面可以删除，springfox-swagger2中会依赖此版本-->
<!--        <dependency>-->
<!--            <groupId>io.swagger</groupId>-->
<!--            <artifactId>swagger-annotations</artifactId>-->
<!--            <version>1.5.20</version>-->
<!--        </dependency>-->

第二步：配置swagger(Bean)

用 @Configuration 注解该类，等价于XML中配置beans；
用 @Bean 标注方法等价于XML中配置bean
不是不可以使用 xml，提倡使用注解

application.propert