使用Swagger2(SSM非Maven项目、springboot)（亲测通过）

最新推荐文章于 2024-02-25 19:14:45 发布

孤独的圆

最新推荐文章于 2024-02-25 19:14:45 发布

阅读量1.1k

点赞数

分类专栏： swagger2 基础配置文章标签： spring java

本文链接：https://blog.csdn.net/qq_36649744/article/details/107684988

版权

基础配置同时被 2 个专栏收录

9 篇文章 0 订阅

订阅专栏

swagger2

1 篇文章 0 订阅

订阅专栏

一、本项目使用的是SSM框架，没有使用maven管理jar包，本次使用的jar包如下所示：（注意使用的jar包请和下图一致，否则很可能因为jar包冲突而引起一些不必要的麻烦）
在这里插入图片描述
1.1、第一件事当然就是导入上面的jar包
百度网盘提取：
链接：https://pan.baidu.com/s/1pTeiwLA_7Ru2XRZXJBmCkw
提取码：kqic
1.2、新建一个package，存放Swagger2的配置文件

package com.jiuling.config;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
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.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration      // 这是控制开关
@EnableSwagger2     // 这是用了 swagger2
@EnableWebMvc   // 这是因为工程用的 springmvc 
@ComponentScan(basePackages = {"com.controller"})  //需要扫描的controller层
public class SwaggerConfig {
    
    //可选择启动项目时是否扫描controller层，与enable(swagger_is_enable)一起使用
	@Value("false")//是否激活swagger2  true激活  false关闭
	private boolean swagger_is_enable;
	
    @Bean
    public Docket customDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
        		.enable(swagger_is_enable)
                .select()            //select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现
                .apis(RequestHandlerSelectors.any()) //扫描指定包内所有Controller定义的Api，并产生文档内容（除了被@ApiIgnore指定的请求）。
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo()); //用来创建该Api的基本信息（这些基本信息会展现在文档页面中）
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("旅游网站").description("接口文档").version("1.0").build();
    }

}

1.3、在 spring-mvc.xml 中添加扫描文件的信息

<mvc:annotation-driven/>
    <bean class="com.SwaggerConfig" /><!-- 这里填写的是你存放Swagger2的配置文件的路径 -->
    <!-- 这里其实是为了解决静态资源访问的问题, 这是一种解决方式 -->
    <mvc:default-servlet-handler/>	
    <mvc:resources mapping="/resources/**" location="WEB-INF/resources"/>

1.4、在 spring-mvc的拦截器做处理，即在 web.xml 中追加：

  <servlet-mapping>
        <servlet-name>dispatcherServlet</servlet-name>
        <url-pattern>*.do</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>default</servlet-name>
        <url-pattern>/swagger-ui.html</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>dispatcherServlet</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>dispatcherServlet</servlet-name>
        <url-pattern>/v2/api-docs</url-pattern>
    </servlet-mapping>

1.5、经过以上配置之后，启动swagger2应该就没什么问题了，接下来就是在controller层添加注解，关于注解请自行百度了。

二、springboot集成swagger2

2.1 网上有很多的springboot集成swagger2的教程，在这里记录一下,首先在pom文件中引入依赖，经测试，以下两种依赖都是可行的，任选其一加入pom文件即可：

2.1.1 一般情况

 <!-- swagger的依赖-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>

2.1.2 这里只加swagger-spring-boot-starter这个依赖也可以

<!-- swagger -->
        <dependency>
            <groupId>com.spring4all</groupId>
            <artifactId>swagger-spring-boot-starter</artifactId>
            <version>1.8.0.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>26.0-jre</version>
        </dependency>

2.2 新建一个类，存放Swagger2的配置文件

package com.lcm.web.config;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
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.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration      // 这是控制开关
@EnableSwagger2     // 这是用了 swagger2
public class Swagger2Config {

	@Value("true")//是否激活swagger2  true激活  false关闭
	private boolean swagger_is_enable;
	
    @Bean
    public Docket customDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
        		.enable(swagger_is_enable)
                .select()            //select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现
                .apis(RequestHandlerSelectors.basePackage("com.lcm.web.controller")) //扫描指定包内所有Controller定义的Api，并产生文档内容（除了被@ApiIgnore指定的请求）。
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo()); //用来创建该Api的基本信息（这些基本信息会展现在文档页面中）
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("测试项目").description("接口文档").version("1.0").build();
    }

}

注意：这个配置文件的内容其实和上面的差不多，唯一的区别就是没有@EnableWebMvc这个注解

2.3 另外，在springboot项目中，是否启用swagger2可以在application.yml文件中进行配置,添加以下语句即可，如果没有添加，默认是开启的：

swagger:
  enabled: true

2.4 简化后的swagger2的完整配置文件如下：

package com.lcm.web.config;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
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.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration      // 这是控制开关
@EnableSwagger2     // 这是用了 swagger2
public class Swagger2Config {
    
    @Bean
    public Docket customDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()            //select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现
                .apis(RequestHandlerSelectors.basePackage("com.lcm.web.controller")) //扫描指定包内所有Controller定义的Api，并产生文档内容（除了被@ApiIgnore指定的请求）。
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo()); //用来创建该Api的基本信息（这些基本信息会展现在文档页面中）
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("测试项目").description("接口文档").version("1.0").build();
    }

}

三、
3.1、有的时候我们需要设置权限，需要通过认证之后才能通过swagger测试接口，那可以像下面这样写：

package com.lcm.web.config;

import com.google.common.collect.Lists;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.List;

@Configuration
@EnableSwagger2
public class Swagger2 {


    @Bean
    public Docket userApis() {
        List<Parameter> parameters = Lists.newArrayList();
        ParameterBuilder ticketPar = new ParameterBuilder();
        ticketPar.name("Authorization").modelRef(new ModelRef("string")).parameterType("header")
                .required(true).build();
        parameters.add(ticketPar.build());
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
                .apis(RequestHandlerSelectors.basePackage("com.lcm.web.controller"))
                .paths(PathSelectors.any())
                .build().globalOperationParameters(parameters);
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("一人一档").description("接口文档")
                .version("1.0").build();
    }


}