SpringBoot集成Swagger3与拦截器InterceptorConfig

Swagger3的介绍

Swagger是一组围绕 OpenAPI 规范构建的开源工具，可帮助您设计、构建、记录和使用 REST API。主要的 Swagger 工具包括：

Swagger Editor – 基于浏览器的编辑器，您可以在其中编写 OpenAPI 规范。
Swagger UI – 将 OpenAPI 规范呈现为交互式 API 文档。
Swagger Codegen – 根据 OpenAPI 规范生成服务器存根和客户端库。
Swagger 的优势 支持API 自动生成同步的在线文档:使用 Swagger 后可以直接 通过代码生成文档,不再需要自己手动编写接口文档了

pom.xml如下

    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-boot-starter</artifactId>
        <version>3.0.0</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>3.0.0</version>
    </dependency>

创建SwaggerConfig.java

在cofig项目下创建

package com.example.demo.cofig;

import io.swagger.annotations.ApiOperation;
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.builders.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
@Configuration
@EnableOpenApi
public class SwaggerConfig {
/**
* 创建API应用
* apiInfo() 增加API相关信息
* 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，
* 本例采用指定扫描的包路径来定义指定要建立API的目录。
*
* @return
*/
@Bean
public Docket restApi() {
return new Docket(DocumentationType.OAS_30)
.groupName(“标准接口”)
.apiInfo(apiInfo(“Spring Boot中使用Swagger3构建RESTful APIs”, “1.0”))
.useDefaultResponseMessages(true)
.forCodeGeneration(false)
.select()
.apis(RequestHandlerSelectors.basePackage(“com.example.demo.controller”))
.paths(PathSelectors.any())
.build();
}

/**
 * 创建该API的基本信息（这些基本信息会展现在文档页面中）
 * 访问地址：http://ip:port/swagger-ui.html
 *
 * @return
 */
private ApiInfo apiInfo(String title, String version) {
    return new ApiInfoBuilder()
            .title(title)
            .description("更多请关注: https://blog.csdn.net/xqnode")
            .termsOfServiceUrl("https://blog.csdn.net/xqnode")
            .contact(new Contact("chaoge", "https://blog.csdn.net/xqnode", "chaoge@163.com"))
            .version(version)
            .build();
}

}

创建InterceptorConfig.java并释放Swagger3

@Override
public void addInterceptors(InterceptorRegistry registry) {
registry
.addInterceptor(getAuthInterceptor())
.addPathPatterns(“/“)
.excludePathPatterns(”/swagger-resources/”, “/webjars/", "/v3/”, “/swagger-ui.html/**”,“doc.html”,“/error”);
super.addInterceptors(registry);
}

标题