Swagger的配置解析

首先，使用swagger2需要先在maven中引入

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

并且，在使用swgger2还需要你的pom.xml中有

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

然后，就可以配置Swagger的配置文件了

 

import com.google.common.base.Predicates;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author Xing
 * @Date 2022/11/2
 * @apiNote
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("Xing")
                /**控制上图中标序号的地方*/
                .apiInfo(apiInfo())
                .select()
                .paths(Predicates.not((PathSelectors.regex("/admin/.*"))))
                .build();
    }

    //基本信息的配置，信息会在api文档上显示,自定义文档信息
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                /**控制上文中序号一，引号中的会显示在上面*/
                .title("接口文件测试")
                /**控制上文中序号二，引号中的会显示在上面*/
                .description("相关接口的文档")
                /**控制上文中序号三，引号中的会显示在上面*/
                .version("2.0")
                /**控制上文中序号四，点击第一行中的字会跳转到二个引号
                中的网址，第二行的邮箱地址是第三个引号中的邮箱地址*/
                .contact(new Contact("xxx的文档", "http://baidu.com", "123@qq.com"))
                .build();
    }
}

groupName("Xing")

 控制分组名的地方

paths(Predicates.and(PathSelectors.regex("/admin/.*")))

 代表页面只会显示admin下的页面