1.引入maven文件
<!-- swagger工具包引入 -->
<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>
2.编写配置文件
package com.example.testrockmq.config;
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.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;
/**
* Swagger配置类
* @author kevin
* @date 2020/12/23
*/
@EnableSwagger2
@Configuration
public class SwaggerConfig {
@Value("${swagger.enable:false}")
private boolean enableSwagger;
/**
* swagger2的配置文件,这里可以配置swagger2的一些基本的内容,比如扫描的包等等
*
* @return springfox.documentation.spring.web.plugins.Docket
* @author kevin
* @date 2021/1/26 14:14
*/
@Bean
public Docket createRestApi() {
ParameterBuilder ticketPar = new ParameterBuilder();
List<Parameter> pars = new ArrayList<>();
//设置所有接口的请求头
ticketPar.name("token").description("用户token信息")
.modelRef(new ModelRef("string")).parameterType("header")
//header中的ticket参数非必填,传空也可以
.required(false).build();
pars.add(ticketPar.build()); //根据每个方法名也知道当前方法在设置什么参数
return new Docket(DocumentationType.SWAGGER_2)
//接扣文档的相关信息
.apiInfo(apiInfo())
//配置是否启用swagger
.enable(enableSwagger)
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.testrockmq.controller"))
.paths(PathSelectors.any())
.build()
.globalOperationParameters(pars);
}
/**
* api文档的详细信息函数
*
* @return springfox.documentation.service.ApiInfo
* @author kevin
* @date 2021/1/26 14:12
*/
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("自己玩儿项目")
.description("自己玩儿项目API文档")
.version("1.0.0")
.contact(new Contact("kevin", "https://blog.csdn.net/liu649983697", "649983697@qq.com"))
.build();
}
}
3.在application.yml中添加
添加原因:Spring Boot 2.6.X使用PathPatternMatcher匹配路径,Swagger引用的Springfox使用的路径匹配是基于AntPathMatcher的。
spring:
application:
name: boot-rocketmq-demo
mvc:
pathmatch:
matching-strategy: ant_path_matcher
4.访问http://127.0.0.1:8080/swagger-ui.html