你还在手动维护接口文档吗，快来试试Swagger2吧!

本文链接：https://blog.youkuaiyun.com/hailongcsdn/article/details/107473353

随着前后端分离的开发模式普及，接口沟通成本增加。Swagger2提供了解决方案，它可以动态生成API接口文档，简化项目开发流程。本文将介绍Swagger2的简单介绍，以及如何在SpringBoot项目中整合Swagger2，包括引入依赖、配置类设置和访问接口文档页面。

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

文章目录

- - 你还在手动维护接口文档吗，快来试试Swagger2吧!

你还在手动维护接口文档吗，快来试试Swagger2吧!

1、Swagger2简单介绍

现在前后端分离逐渐成为了Web项目的一种标准开发方式，就是前端和后端由不同的人员开发，前端人员负责前端的项目开发，后端人员负责后端项目的开发。但是与此同时，项目开发的沟通成本也随之升高。主要在于前后端人员对于WebApi接口的相互沟通。我们使用Swagger2接口文档，可以动态生成Api接口文档，可以促进项目的高效开发。

2、SpringBoot整合Swagger2

2.1、引入依赖

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

        <!-- https://mvnrepository.com/artifact/com.github.xiaoymin/swagger-bootstrap-ui -->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.3</version>
        </dependency>

2.2、设置Swagger2配置类

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
                .ignoredParameterTypes(HttpSession.class,HttpServletRequest.class,HttpServletResponse.class)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.swaggerui.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo(){
        Contact contact=new Contact("codelong","www.codelong.com","1234567@qq.com");
        return new ApiInfo("Swagger接口文档",
                "下面是Swagger接口文档信息",
                "v1.0",
                "http://localhost:8080",
                contact,
                "",
                "",
                new ArrayList<>());
    }
}