说明
分两个版本，一个是3.0之前的版本配置，一个是3.0版本的配置
3.0之前
maven配置
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.10.5</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.10.5</version>
</dependency>
3.0版本
maven配置
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
config文件
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.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
//@EnableSwagger2 //3.0版本之前
@EnableOpenApi //3.0版本
public class Swagger2Config {
// swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
// 为当前包路径
.apis(RequestHandlerSelectors.basePackage("com.tool.pc.controller")).paths(PathSelectors.any())
.build();
}
// 构建 api文档的详细信息函数,注意这里的注解引用的是哪个
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
// 页面标题
.title("接口文档")
// 创建人信息
.contact(new Contact("ljy", "https://www.321tool.com", "xxx@qq.com"))
// 版本号
.version("V1.0")
// 描述
.description("接口")
.build();
}
}
controller配置
@RestController
@RequestMapping("/bookType")
@CrossOrigin
@Api("书籍类型接口")
public class BookTypeController {
@Autowired
private BookTypeService bookTypeService;
@ApiOperation(value = "书籍类型列表",notes = "查询书籍类型列表")
@GetMapping("/list")
public Result list(){
return new Result(true, StatusCode.OK,"查询成功",bookTypeService.list());
}
}
权限
如果加了验证的配置文件的话，需要将swagger相关的接口放开
3.0之前
"/swagger-resources/**", "/webjars/**", "/v2/**", "/swagger-ui.html/**"
3.0版本
"/swagger-resources/**", "/webjars/**", "/v2/**", "/swagger-ui/**"
访问地址
3.0之前
http://127.0.0.1:8002/swagger-ui.html
3.0版本
http://127.0.0.1:8002/swagger-ui/index.html
