spring mvc 集成swagger

最新推荐文章于 2025-06-19 14:49:32 发布

ValleyG

最新推荐文章于 2025-06-19 14:49:32 发布

阅读量310

点赞数

CC 4.0 BY-SA版权

文章标签： java

本文链接：https://blog.youkuaiyun.com/zhm123098/article/details/83626613

本文记录了在项目中集成Swagger的过程，以解决API文档需求。首先介绍了引入相关依赖，接着详细说明了配置文件的编写步骤，特别提醒需确保Spring能扫描到配置。最后指出，熟悉Swagger的核心注解就能轻松上手使用。

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

最近因项目需求需要api文档，发现swagger呼声挺高，于是乎就集成了一下，配置过程中网上配置各种坑，写此博客记录

第一步，映入依赖

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

第二步，编写配置文件

import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.ApiSelectorBuilder;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 *
 * @author 20014915
 * @date 2018-11-01
 */
@Configuration
@EnableSwagger2
@EnableWebMvc //记得加该注解，否者报错
public class SwaggerConfig {
    @Value("${swagger.switch}")
    private boolean swaggerSwitch;
    /**
     * 创建API应用
     * apiInfo() 增加API相关信息
     * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，
     * 本例采用指定扫描的包路径来定义指定要建立API的目录。
     *
     * @return
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .enable(swaggerSwitch)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 创建该API的基本信息（这些基本信息会展现在文档页面中）
     * 访问地址：http://项目实际地址/swagger-ui.html
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("测试APIs")
                .description("更多请关注http://www.baidu.com")
                .termsOfServiceUrl("http://www.baidu.com")
                .contact("小崽子")
                .version("1.0")
                .build();
    }
}

package com.lppz.shop.dingding.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

/**
 * Created by 20014915 on 2018-11-01.
 */
@Configuration
@EnableWebMvc
@ComponentScan("com.lppz.shop.dingding.modules")//这个是扫描controller接口
public class WebConfig extends WebMvcConfigurerAdapter{
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}

（千万别忘记spring扫描到这两个配置文件）

这样就算配置完成了，至于swagger的具体使用就没有什么好啰嗦的，了解几个注解就基本ok了