Swagger2的配置教程

首先新建一个springboot项目，然后在pom文件中导入swagger的相关依赖，分别是以下两个：

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>

Springfox Swagger UI

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

也可以进入maven官网自行下载其他版本的swagger依赖，maven官方地址如下：

jMaven Repository: springfox (mvnrepository.com)https://mvnrepository.com/search?q=springfoxhttps://mvnrepository.com/search?q=springfox

点击进入maven官网，搜索springfox-swagger即可找到

导入相关依赖之后，要想使用Swagger，还需要对Swagger进行配置，在项目中建立一个config包，包下建立一个SwaggerConfig配置类来对Swagger进行配置，如下：

在SwaggerConfig类上面写上注解@Configuration和@EnableSwagger2，其中@Configuration
表示这是一个配置类；而@EnableSwagger2注解来启用Swagger；此时Swagger已经可以使用了，但是都是较原始的内容显示。

扫描二维码关注公众号，回复： 15275715 查看本文章

启动项目，如果springboot版本太高就可以会抛出异常，建议降低版本，我后面就是把springboot版本降到2.5.6就可以启动了。启动之后访问http://localhost:8080/swagger-ui.html

再对swagger进行下一步的配置，因为Swagger实例Bean是Docket，所以必须通过配置Docket实例来配置Swaggger。

package com.hu.SpringBoot01.config;

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.Contact;
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.ArrayList;
import java.util.List;

@Configuration //说明这是一个配置类
@EnableSwagger2//该注解开启Swagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        //添加head参数配置start
        ParameterBuilder tokenPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<>();
        tokenPar.name("Authorization").description("令牌")//请求头，测试token时可以用到
                .modelRef(new ModelRef("string"))
                .parameterType("header")
                .required(false)
                .build();
        pars.add(tokenPar.build());
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()
                //扫描的路径包,会将包下的所有被@Api标记类的所有方法作为api
                .apis(RequestHandlerSelectors.basePackage("com.hu.SpringBoot01.controller"))
                .paths(PathSelectors.any())//所有接口
                .build()
                .globalOperationParameters(pars);

    }
    private ApiInfo webApiInfo() {
        return new ApiInfoBuilder()
                .title("新生入学后台管理系统接口文档")
                .description("Swagger2后台管理系统在线文档")
                .contact(new Contact("胡雁南","localhost:8080/swagger-ui.html","[email protected]"))
                .version("2.1")
                .build();
    }
}

此时swagger就可以正常使用了，访问http://localhost:8080/swagger-ui.html

Swagger2的配置教程

猜你喜欢