如何在spring webflux RouterFunctionendpoint中使用OpenApi注释？

Question

我目前正在做一个项目，在这个项目中我使用了spring functional web编程。我通常在restController中使用swagger 2的注释，但是对于函数式web编程，我找不到在哪里！告诉应用程序搜索endpoint(如Docket中的basepackage)并在html页面中加载swagger的地方。以下是我的代码:

@Configuration
public class RouterClient{

@Bean
public RouterFunction<ServerResponse> routes(ClientHandler client){
  return route(GET("/api/client"), client::findAll)
      .andRoute(POST("/api/client"),client::add);
  }
}

配置类：

@Configuration
public class OpenApiConfiguration{

  @Bean
    public GroupedOpenApi groupOpenApi() {
        String paths[] = {"/api/**"};
        String packagesToscan[] = {"com.demo.client"};
        return GroupedOpenApi.builder().setGroup("groups").pathsToMatch(paths).packagesToScan(packagesToscan)
                .build();
    }

}

依赖项：

    <dependency>
        <groupId>org.springdoc</groupId>
        <artifactId>springdoc-openapi-webflux-core</artifactId>
        <version>1.2.32</version>
    </dependency>
    <dependency>
        <groupId>org.springdoc</groupId>
        <artifactId>springdoc-openapi-webflux-ui</artifactId>
        <version>1.2.32</version>
    </dependency>

结果是：

Answer 1

https://springdoc.org/您需要springdoc openapi webflux ui和@RouterOperation。

Answer 2

设置

springdoc.api-docs.enabled=false

这将跳过API注释的类路径扫描（springfox）。（OAS3在v3中替换了这些）并将它们替换为规范文件中的读取（json/yaml）。

将留档放在Spec文件中，因为可以从中生成任意数量的客户端。从遗留代码开始的最简单方法是复制由springfox生成的/api-docs/文件。

您可以转到编辑器.swagger。io，加载版本2的yaml并将其转换为版本3，如果springfox仍然不这样做。然后使用yaml文件。（这是一个合同预先规范，是有原因的。）

Answer 3

自1.3.8（5月初）起支持功能endpoint。请参阅GitHub上的版本。

看看这个：https://springdoc.org/#spring-webfluxwebmvc-fn-with-functional-endpoints

在 Swagger UI 上查看终结点的最简单方法是将@RouterOperation注释添加到 RouterFunction 方法（包含单个路由）中，并指定其中使用的 beanClass 和 beanMethod。但是，在您的情况下，单个方法上有多个路由，因此您还必须使用@RouterOperations注释。这些案例在上面的链接中有详细的记录。

似乎目前 springdoc-openapi 的实现只允许手动添加文档。