文章目录
1. 微服务项目搭建
版本总结:
- spring boot: 2.6.13
- springfox-boot-starter :springfox-boot-starter
等有空了上图
2. 整合 Swagger 信息
整合官方网址: 地址链接
-
引入依赖
<!--springfox 依赖--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version>
<!-- Spring Boot Web Starter --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency>
-
配置
@Configuration
@EnableOpenApi //Enable open api 3.0.3 spec
public class SwaggerConfig {
}
spring boot: 2.6.13 整合 swagger3.0.x 需要添加一个一个配置,否则会报空指针异常
// 源码 WebMvcProperties 类中是spring.mvc可以配置的属性
spring:
mvc:
pathmatch:
matching-strategy: ANT_PATH_MATCHER
以下是测试demo的配置和验证:
- 配置信息
@Configuration
@EnableOpenApi //Enable open api 3.0.3 spec // // http://localhost:8089/swagger-ui/
public class SwaggerConfig {
/**
* 创建API应用
* apiInfo() 增加API相关信息
* 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现,
* 本例采用指定扫描的包路径来定义指定要建立API的目录。
*
* @return
*/
// 访问地址 http://localhost:8089/swagger-ui/
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.testdemo.controller")) // 替换为你的包名
.paths(PathSelectors.any())
.build()
.apiInfo(apiInfo("demo", "v1.1"));
}
}
- 测试代码
@RestController
@RequestMapping("/api")
@Api(tags = "测试")
public class testController {
@ApiOperation(value &#