SpringBoot结合swagger2快速生成简单的接口文档

最新推荐文章于 2021-09-26 10:18:17 发布

山海皆可平，难平是人心

最新推荐文章于 2021-09-26 10:18:17 发布

阅读量217

点赞数

分类专栏： SpringBoot 文章标签： swagger springboot

本文链接：https://blog.youkuaiyun.com/qq_41210698/article/details/89503938

版权

SpringBoot 专栏收录该内容

18 篇文章

订阅专栏

本文档介绍了如何在SpringBoot项目中结合Swagger2快速生成接口文档。主要步骤包括在pom.xml添加依赖，启动类启用@EnableSwagger2Doc注解，以及在application.properties中的基本配置。值得注意的是，即使不配置application.properties，Swagger2也能生成并测试接口文档。如需了解更多详情，可访问作者的个人网站。

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

1. pom.xml中加入依赖

        <dependency>
            <groupId>com.spring4all</groupId>
            <artifactId>swagger-spring-boot-starter</artifactId>
            <version>1.8.0.RELEASE</version>
        </dependency>

2. 在启动类（即带@SpringBootApplication这个注解的类）上添加@EnableSwagger2Doc注解

3. 在application.properties中配置如下

swagger.enabled=true
swagger.title=spring-boot-mybatis module api
swagger.description=Starter for swagger 2.x
swagger.license=Apache License, Version 2.0
swagger.licenseUrl=https://www.apache.org/licenses/LICENSE-2.0.html
swagger.termsOfServiceUrl=https://github.com/pbw123/spring-boot-demo
swagger.contact.name=mqXu
swagger.contact.url=https://www.jianshu.com/u/2f60beddf923
swagger.contact.email=2635225112@qq.com
swagger.base-package=com.springboot.mybatis.controller
swagger.base-path=/**
swagger.exclude-path=/error, /ops/**

经我多次尝试application.properties中不加任何swagger配置也可生成文档进行正常测试