SpringBoot集成Swagger，前后端接口文档解决方案。集成SpringDoc，支持SpringBoot3.x。

原创

已于 2023-03-27 21:36:23 修改 · 3.7k 阅读

9 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #java #spring

于 2023-01-21 22:01:07 首次发布

本文介绍了如何在SpringBoot项目中集成Swagger和SpringDoc，以自动化生成和维护前后端接口文档。通过配置信息类、使用相关注解，实现了接口的清晰描述，并提供了测试查看接口的功能。当SpringBoot升级到3.x，推荐使用SpringDoc作为新的接口文档解决方案。

一个不断在迭代的项目，Controller层与POJO层肯定会是经常变动的，在目前前后端分离的大环境背景下有一份接口文档可以极大减少项目组成员之间的交流成本，也能支持自动化测试，但靠人工维护该文档总是不够稳妥，因此我们可以使用Swagger，为响应式接口文档提供了一种解决方案。

一，Swagger

1，准备工作

首先在项目中引入Swagger依赖

<!-- swagger -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>3.0.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>3.0.0</version>
</dependency>

2，准备配置信息类、相关注解使用

如果没有特殊需求的话，下列配置信息只需要修改apiInfo方法中的联系人信息即可。

package com.sy;

/**
 * Swagger3.0 接口文档配置类
 */
@Configuration
@EnableOpenApi //表示开启生成接口文档功能（只有开启了OpenApi,才可以实现生成接口文档的功能）
@EnableWebMvc
public class SwaggerConfig implements WebMvcConfigurer {
   
   
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
   
   
        registry.addResourceHandler("/**").addResourceLocations(
            "classpath:/static/");
        registry.addResourceHandler("swagger-ui.html").addResourceLocations(