1. 添加依赖
<!--swagger3-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
2. 创建SwaggerConfig.java文件
package com.example.mag_springboot01.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
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
@EnableWebMvc //解决Springfox3.0与2.6.0及以上版本的冲突的问题
public class SwaggerConfig {
/**
* 创建API应用
* apiInfo() 增加API相关信息
* 通过select() 函数返回一个A屁SelectBuilder实例,用来控制哪些接口暴漏给Swagger来展现
* 本例采用扫描的包路径来定义指定要建立API的目录
* @return
*/
@Bean
public Docket restApi() {
return new Docket(DocumentationType.OAS_30)
.groupName("标准接口")
.apiInfo(apiInfo("后台管理系统", "1.0"))// 用于生成API文档
.useDefaultResponseMessages(true)
.forCodeGeneration(false)
.select()//select()函数返回一个ApiSelectorBuilder实例,用来控制接口被Swagger做成文档
.apis(RequestHandlerSelectors.basePackage("com.example.mag_springboot01.controller"))
.paths(PathSelectors.any())//选择所有的API,如果你想只为部分API生成文档,可以配置在这里
.build();
}
private ApiInfo apiInfo(String title, String version) {
return new ApiInfoBuilder()
.title(title)
.version(version)
.description("更多关注")
.contact(new Contact("zzq", "zzq123.com", "zzq@qq.com"))
.build();
}
}
3. 直接在浏览器上输入http://localhost:8081/swagger-ui/index.html