第一步:引入依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
第二步:配置文件
package com.example.realdemo.demos.web.config;
import io.swagger.annotations.Api;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
@Configuration
@EnableOpenApi
public class swaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.OAS_30) // v2 不同
.select()
.apis(RequestHandlerSelectors.withClassAnnotation(Api.class)) // 设置扫描路径
.build();
}
}
如果SpringBoot版本较低,出现报错的,在yml配置文件中加入:
spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER
第三步:常用注解
第四步:进入localhost:8080/swagger-ui/index.html中进行接口调试