<dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-starter-webflux-ui</artifactId> <version>2.1.0</version> </dependency>加入后如何使用
时间: 2023-10-30 11:08:41 浏览: 194
添加了 `springdoc-openapi-starter-webflux-ui` 依赖后,我们可以通过访问 `/swagger-ui.html` 或者 `/swagger-ui/index.html` 的方式来查看 API 文档。这里的 `/swagger-ui.html` 或者 `/swagger-ui/index.html` 是 WebFlux 对应的 API 文档页面,如果是使用 Spring Boot 的 Servlet 版本,应该是访问 `/swagger-ui.html`。
此外,我们还需要在 Spring Boot 应用程序启动类上添加 `@EnableSwagger2WebFlux` 注解,启用 Swagger2WebFlux 的自动配置。
下面是一个示例:
```java
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.web.reactive.config.EnableWebFlux;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebFlux;
@SpringBootApplication
@EnableWebFlux
@EnableSwagger2WebFlux
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.example"))
.paths(PathSelectors.any())
.build();
}
}
```
在上面的示例中,我们使用 `@EnableSwagger2WebFlux` 注解启用了 Swagger2WebFlux 的自动配置,并且定义了一个 `Docket` Bean,用于配置 Swagger2WebFlux 的行为。在 `Docket` 中,我们使用 `basePackage` 和 `any` 方法来指定扫描的 API 包和路径。
最后,我们可以使用浏览器访问 `http://localhost:8080/swagger-ui.html` 来查看生成的 API 文档。
阅读全文