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

最新推荐文章于 2024-06-28 10:17:30 发布

原创最新推荐文章于 2024-06-28 10:17:30 发布 · 308 阅读

0 ·

CC 4.0 BY-SA版权

本文介绍如何使用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进行访问