第十一篇:SpringBoot 2.x整合Swagger2

本文介绍如何使用Swagger自动为Spring Boot项目生成API文档,通过简单配置和注解即可完成,极大提高开发效率。无需手动编写文档,Swagger能自动生成并维护接口文档。

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

程序猿最烦两件事,第一件事是别人要他给自己的代码写文档,第二件呢?是别人的程序没有留下文档。

程序员最讨厌的四件事:写注释、写文档、别人不写注释、别人不写文档……

关于写文档这个事情,争论已久,今天就介绍一个解决这个问题的东东,Swagger
这里介绍的是由程序员DD翟永超提供的spring-boot-starter-swagger关于其详细设置在文章底部。

pom.xml

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- 引入swagger2 -->
        <dependency>
            <groupId>com.spring4all</groupId>
            <artifactId>swagger-spring-boot-starter</artifactId>
            <version>1.8.0.RELEASE</version>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

在这里我们需要做的事情就不像引入官方依赖一样需要一个个的加注解,只需要一个注解就OK了。@EnableSwagger2Doc,这个注解加在启动类上

package com.priv.gabriel;

import com.spring4all.swagger.EnableSwagger2Doc;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@EnableSwagger2Doc
@SpringBootApplication
public class Demoforswagger2Application {

    public static void main(String[] args) {
        SpringApplication.run(Demoforswagger2Application.class, args);
    }
}

输入http://localhost:8080/swagger-ui.html进行访问

9988457-911f0757ec754fd9.png
image.png

打开 UserController看一下
9988457-099114d14bc855ca.png
image.png

继续查看一个具体的请求
9988457-6bf97cc4a3c1bbbe.png
image.png

基本信息都有了,也可以在这里测试接口。

可以看到我们几乎没有怎么操作一个文档就建立完毕了。
spring-boot-starter-swagger项目及文档
本项目的下载地址

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值