带有Spring Webflux功能endpoint的SpringDoc

Question

我正在使用Spring Webfluxs的功能endpoint，并希望为它生成一个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的功能endpoint派生openAPI定义？

Answer 1

您可以使用功能性DSL或@RouterAction注释。

更多详细信息可在斯普林多克-openapi 文档的这一部分找到。

此示例代码显示的是有关如何支持功能终结点的演示代码：

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