spring boot 整合 swagger自动生成接口文档，搬砖都快乐了~

原创

于 2022-08-12 14:01:34 发布 · 1.3k 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #swagger #knife4j #接口文档

本文介绍如何使用Spring Boot和Swagger快速生成接口文档，省去繁琐的手动编写过程。只需简单几步配置，即可在项目中添加Swagger注解，通过@Api、@ApiOperation等注解定义接口信息。同时，Swagger还支持模型注解，如@ApiModel和@ApiModelProperty，方便描述请求参数。完成配置后，通过特定URL访问Swagger UI，即可进行接口测试，如同使用Postman，极大提高了开发效率。

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

你是否还在为本就紧张的开发排期还要写接口文档而痛苦？
你是否还在为写接口文档比写接口还痛苦？

那么swagger后端童鞋值得拥有，
spring boot作为最懂程序员的框架，当然为我们想到啦，so easy

1、pom.xml 中引入依赖

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>2.1.18.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>2.0.7</version>
        </dependency>

然后点击maven刷新，就看见它迈着正步走来了~
在这里插入图片描述
2、启动上加上启用swagger注解@EnableSwagger2WebMvc