1.导入依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
<dependency>
<groupId>org.springframework.plugin</groupId>
<artifactId>spring-plugin-core</artifactId>
<version>2.0.0.RELEASE</version>
</dependency>
2.编写Swagger3的接口配置
@Configuration
@EnableOpenApi
public class SwaggerConfig{
/**
* 创建API
*/
@Bean
public Docket createRestApi()
{
@Bean
public Docket createRestApi()
{
return new Docket(DocumentationType.OAS_30)
// 是否启用Swagger
.enable(true)
// 用来创建该API的基本信息,展示在文档的页面中(自定义展示的信息)
.apiInfo(apiInfo())
// 设置哪些接口暴露给Swagger展示
.select()
// 扫描指定包中的swagger注解 注意:不要扫描错误
.apis(RequestHandlerSelectors.basePackage("com.gacrnd.web.controller"))
.paths(PathSelectors.any())
.build()
}
}
/**
* 添加摘要信息
*/
private ApiInfo apiInfo()
{
// 用ApiInfoBuilder进行定制
return new ApiInfoBuilder()
// 设置标题
.title("标题:_接口文档")
// 描述
.description("描述:")
// 作者信息
.contact(new Contact(aidexConfig.getName(), null, null))
// 版本
.version("版本号:" + aidexConfig.getVersion())
.build();
}
}
3.注解
类注解:@API(tags = "说明")
方法注解:@ApiOperation(value = "Swagger3.0测试接口")
4.启动项目访问路径:http://项目地址:项目端口/swagger-ui/index.html
5.会遇到的问题
5.1: No operations defined in spec! 页面打开出现以下情况;
解决:检查扫描地址是否正确