pom依赖

2.7.0

io.springfoxspringfox-swagger2${swagger2.version}

io.springfoxspringfox-swagger-ui${swagger2.version}

application.yml配置

swagger:enable: true

创建SwaggerConfig配置类

package com.yyl.system.config;import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Value;
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.service.ApiKey;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.SecurityScheme;
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;/**
*
* @author  yangyile
* @since 2023-03-16 21:36
*/
@Configuration
@EnableSwagger2
public class SwaggerConfig {@Value("${swagger.enable}")private boolean swaggerEnable;@Beanpublic Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).enable(swaggerEnable).groupName("swagger").apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.yyl.system.controller")).apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)).paths(PathSelectors.any()).build().securitySchemes(unifiedAuth());}//    头部配置private ApiInfo apiInfo() {return new ApiInfoBuilder().title("Spring Boot中使用Swagger2构建RESTful APIs").contact("yangyile").termsOfServiceUrl("https://blog.csdn.net/y2010081134").version("1.0").build();}//    安全认证private static List unifiedAuth() {List arrayList = new ArrayList();arrayList.add(new ApiKey("token验证", "token", "header"));return arrayList;}
}

配置说明

@Configuration注解

表明该类是一个配置类，项目会自动引入swagger。

@EnableSwagger2注解

开启swagger。

@Value(“${swagger.enable}”)注解

指使用application.yml中swagger.enable的配置。

@Bean注解

注入spring容器，定制各个接口。

DocumentationType.SWAGGER_2

指定swagger版本类型。

enable方法

打开或者关闭swagger文档。

groupName方法

分组。

apiInfo方法

配置swagger的基本信息，如标题、作者、联系方式及版本等等。

select和apis方法

设置怎么扫描接口。RequestHandlerSelectors.basePackage(“com.yyl.system.controller”)表示只扫描controller包。RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)表示只对类上用@Api注解且方法上用@ApiOpearation的接口才会暴露给swagger。

paths方法

配置暴露给swagger的路由，PathSelectors.any()表示所有路由。也可以设置正则匹配。

securitySchemes方法

配置安全验证，这里设置token验证。

效果

未完待续。。。