入门配置与springmvc集成

最新推荐文章于 2023-10-20 17:02:58 发布

原创最新推荐文章于 2023-10-20 17:02:58 发布 · 214 阅读

0 ·

CC 4.0 BY-SA版权

Swagger 专栏收录该内容

1 篇文章

订阅专栏

本文详细介绍如何在项目中集成并配置Swagger，包括pom.xml中引入依赖、创建自定义配置类、引入Swagger页面文件、与Spring框架整合等步骤，并提供常用的Swagger注解介绍。

可参考https://blog.csdn.net/y534560449/article/details/53694443

1、pom.xml引入相应的包, 各个包的版本根据情况定

<dependency>  
    <groupId>com.fasterxml.jackson.core</groupId>  
    <artifactId>jackson-core</artifactId>  
    <version>2.5.1</version>  
</dependency>  
<dependency>  
    <groupId>com.fasterxml.jackson.core</groupId>  
    <artifactId>jackson-databind</artifactId>  
    <version>2.5.1</version>  
</dependency>  
<dependency>  
    <groupId>com.fasterxml.jackson.core</groupId>  
    <artifactId>jackson-annotations</artifactId>  
    <version>2.5.1</version>  
</dependency>

2、创建自定义swagger类

@Configuration
@EnableSwagger
@EnableWebMvc
public class SwaggerConfig {
      private SpringSwaggerConfig springSwaggerConfig; 
    /**
     * Required to autowire SpringSwaggerConfig
     */ 
    @Autowired 
    public void setSpringSwaggerConfig(SpringSwaggerConfig springSwaggerConfig) 
    { 
        this.springSwaggerConfig = springSwaggerConfig; 
    }

    /**
     * Every SwaggerSpringMvcPlugin bean is picked up by the swagger-mvc
     * framework - allowing for multiple swagger groups i.e. same code base
     * multiple swagger resource listings.
     */ 
    @Bean 
    public SwaggerSpringMvcPlugin customImplementation() 
    { 
        return new SwaggerSpringMvcPlugin(this.springSwaggerConfig) 
                .apiInfo(apiInfo()) 
                .includePatterns(".*?"); 
    } 

    private ApiInfo apiInfo() 
    { 
        ApiInfo apiInfo = new ApiInfo( 
                  "江湖味系统API",
                "前后端接口API管理",
                "",
                "291529461@qq.com",
                "无",
                "");
        return apiInfo; 
    }
}

3、引入swagger页面文件
到git上下载2.1.5版本的swagger-ui：https://github.com/swagger-api/swagger-ui/tree/v2.1.5/dist
下载后将dist文件夹全部拷贝到webapp目录下，如下图：
这里写图片描述

4、与spring整合

<!-- 将 springSwaggerConfig加载到spring容器 --> 
<bean class="com.mangofactory.swagger.configuration.SpringSwaggerConfig" />
<!-- 将自定义的swagger配置类加载到spring容器 --> 
<bean class="com.taster.util.config.SwaggerConfig" />  
<!-- 静态资源文件，不会被Spring MVC拦截 -->  
<mvc:resources mapping="/swagger/**" location="/WEB-INF/swagger/" />

5、配置到controller中

这里写图片描述

6、swagger常用注解介绍与使用

参考地址1：https://www.jianshu.com/p/12f4394462d5

参考地址2：https://blog.csdn.net/xupeng874395012/article/details/68946676