SpringMVC中swagger配置

曾经终败给现在 2022-05-25 13:25 234阅读 0赞

1、导入依赖

<dependency>
                <groupId>com.mangofactory</groupId>
                <artifactId>swagger-springmvc</artifactId>
                <version>1.0.2</version>
                <exclusions>
                    <exclusion>
                        <groupId>org.springframework</groupId>
                        <artifactId>spring-web</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
            <dependency>
                <groupId>com.mangofactory</groupId>
                <artifactId>swagger-models</artifactId>
                <version>1.0.2</version>
                <exclusions>
                    <exclusion>
                        <groupId>org.springframework</groupId>
                        <artifactId>spring-web</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
            <dependency>
                <groupId>com.wordnik</groupId>
                <artifactId>swagger-annotations</artifactId>
                <version>1.3.11</version>
            </dependency>
            <dependency>
                <groupId>com.fasterxml</groupId>
                <artifactId>classmate</artifactId>
                <version>1.1.0</version>
            </dependency>
            <dependency>
                <groupId>com.fasterxml.jackson.core</groupId>
                <artifactId>jackson-databind</artifactId>
                <version>2.6.6</version>
            </dependency>

2、新建SwaggerConfig类

package com.xxx.xxx.common.config;
    
    import com.mangofactory.swagger.configuration.SpringSwaggerConfig;
    import com.mangofactory.swagger.models.dto.ApiInfo;
    import com.mangofactory.swagger.plugin.EnableSwagger;
    import com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    
    /**
     * Created by hgg on 2018/5/15.
     */
    @EnableSwagger
    public class SwaggerConfig {
    
        private SpringSwaggerConfig springSwaggerConfig;
    
        @Autowired
        public void setSpringSwaggerConfig(SpringSwaggerConfig springSwaggerConfig) {
            this.springSwaggerConfig = springSwaggerConfig;
        }
    
        /**
         * 标题以及需要展示接口的路径
         */
        @Bean
        public SwaggerSpringMvcPlugin customImplementation() {
            return new SwaggerSpringMvcPlugin(this.springSwaggerConfig)
                    .apiInfo(apiInfo())
    //                .pathProvider(new RestApiPathProvider())
                    .includePatterns("(/api/.*)|(/WeChat/.*)");
        }
    
        private ApiInfo apiInfo() {
            ApiInfo apiInfo = new ApiInfo(
                    "XXXAPI",
                    "XXXAPI",
                    "XXX有限责任公司",
                    "xxx@qq.com",
                    "",
                    "");
            return apiInfo;
        }
    }

3、SpringMVC配置文件

<bean class="com.mangofactory.swagger.configuration.SpringSwaggerConfig" />
        
        <bean class="com.xxx.xxx.common.config.SwaggerConfig" />
    
        <mvc:resources mapping="/swagger/**" location="/swagger/"/>

4、下载swagger放入webapp目录下（[已打包点击下载][Link 1]）

如果有异常，修改swagger中index.html

![70][]

[Link 1]: https://download.csdn.net/download/hgg923/10416025
[70]: /images/20220525/a81283d2cfc6411bbd71ad59aa920a78.png