集成目的
集成步骤
前提条件:您创建好一个SpringBoot的项目,并且它可以运行。
First Step
- 引入Maven依赖
<!-- 引入Swagger3依赖 -->
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.6.12</version>
</dependency>
- spring properties 里面可以添加控制属性
# 是否启用 openapi-ui 生产环境可以设置关闭
springdoc.api-docs.enabled=true
# openapi-ui 扫描的包路径
springdoc.packages-to-scan=com.rb.redisdemo.web
- 新增配置类 OpenApiConfig
@Configuration
public class OpenApiConfig {
@Bean
public OpenAPI initOpenAPI() {
return new OpenAPI().info(
new Info().title("Redis demo API").description("OpenAPI").version("v1.0")
);
}
}