swagger 3.0 于2020.07月发布,其实3.0版本与2.x版本大同小异。
主要步骤:
- 添加依赖
- 开启swagger
- 配置摘要信息
- 访问 Swagger 页面
添加依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>${springfox.version}</version>
</dependency>
开启swagger
@EnableOpenApi //开启 Swagger
@SpringBootApplication
public class Application {
}
Spring Boot 的启动类或配置类中添加 @EnableOpenApi, 该注解加不加作用不明显。
@Configuration
@EnableConfigurationProperties(SpringfoxConfigurationProperties.class)
@ConditionalOnProperty(value = "springfox.documentation.enabled", havingValue = "true", matchIfMissing = true)
@Import({
OpenApiDocumentationConfiguration.class,
SpringDataRestConfiguration.class,
BeanValidatorPluginsConfiguration.class,
Swagger2DocumentationConfiguration.class,
SwaggerUiWebFluxConfiguration.class,
SwaggerUiWebMvcConfiguration.class
})
@AutoConfigureAfter({ WebMvcAutoConfiguration.class, JacksonAutoConfiguration.class,
HttpMessageConvertersAutoConfiguration.class, RepositoryRestMvcAutoConfiguration.class })
public class OpenApiAutoConfiguration {
}
先查看 springboot 的 spring.factories 自动化配置文件中就能看到:
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\springfox.boot.starter.autoconfigure.OpenApiAutoConfiguration
该注解加不加“作用不明显”原因:
根据 OpenApiAutoConfiguration 上的 @ConditionalOnProperty 条件注解中的定义,该注解中matchIfMissing=true, 指配置文件application.properties中未进行对应属性配置时的默认处理。true 没有对应的属性配置,则自动配置默认生效,反之false 不生效。
如果在 application.properties 中设置配置属性 springfox.documentation.enabled=false,即关闭了 swagger 功能,此时自动化配置类就不执行。可以通过 @EnableOpenApi 注解导入 OpenApiDocumentationConfiguration 配置类。
技术上来说逻辑是这样,不过应用中暂未发现这样的需求(即在 application.properties 中关闭 swagger,再通过 @EnableOpenApi 注解开启)。
配置摘要信息
@Configuration
public class SwaggerConf {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.OAS_30) // v2 不同
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.**.controller")) // 设置扫描路径
.paths(PathSelectors.any())
.build()
;
}
private ApiInfo apiInfo(){
return new ApiInfoBuilder().title("接口文档").description("By AA").version("1.0.0")
.contact(new Contact("aaaa","http://localhost:8080/","aaaa@example.com")).build();
}
}
访问 Swagger 页面
新版本的 Swagger 访问地址和老版本的地址是不同的,新版的访问地址是localhost:8080/swagger-ui/,文档:localhost:8080/v3/api-docs
仅供学习。