SpringDoc 與 Spring Webflux 功能端點

Question

我正在使用 Spring Webfluxs 的功能端點，並希望為其生成一個 openAPI 定義。

我添加了SpringDoc ，但生成的 openAPI 定義為空：

{
  "openapi": "3.0.1",
  "info": {
    "title": "OpenAPI definition",
    "version": "v0"
  },
  "servers": [
    {
      "url": "http://localhost:8080",
      "description": "Generated server url"
    }
  ],
  "paths": {},
  "components": {}
}

端點定義如下

@Configuration(proxyBeanMethods = false)
public class Routers {

    @Bean
    public RouterFunction<ServerResponse> uploadRoute(UploadHandler uploadHandler) {
        return RouterFunctions
                .route(POST("/api/upload").and(accept(MediaType.MULTIPART_FORM_DATA)), uploadHandler::handleUploadedFiles);
    }
}

是否可以從 Springs 的功能端點派生 openAPI 定義？

Answer 1

SpringDoc稍后在其文檔中對其進行了描述。

Answer 2

您可以使用功能性 DSL 或@RouterOperations注釋。

springdoc-openapi 文檔的這一部分提供了更多詳細信息。

此示例代碼顯示的是一個演示代碼，用於了解如何支持功能端點：

• https://github.com/springdoc/springdoc-openapi-demos/tree/master/springdoc-openapi-spring-boot-2-webflux-functional