WebFlux Swagger（开放API）Integraton-POST请求示例

Question

我已经将Swagger（OpenAPI）与Spring Webflux集成，如下所述:https://springdoc.org/#spring-weblfuxwebmcfn-with-functional-endpoints using routeroperation。集成工作良好，可以在/swagger-ui.html访问

@Configuration
public class  MyRouter {

    @RouterOperations({
            @RouterOperation(path = "/data", beanClass = MyHandler.class, beanMethod = "getData"),
            @RouterOperation(path = "/allData", beanClass = MyHandler.class, beanMethod = "getAllData") })

    @Bean
    public RouterFunction<ServerResponse> route(MyHandler MyHandler) {

        return RouterFunctions
                .route(RequestPredicates.POST("/data").and(RequestPredicates.accept(MediaType.APPLICATION_JSON)), MyHandler::getData)
                .andRoute(RequestPredicates.GET("/allData").and(RequestPredicates.accept(MediaType.APPLICATION_JSON)), MyHandler::getAllData);
    }
}

添加RouterOperations注释后，我可以看到swagger-ui正确地显示了GET和POST API，但没有显示请求模式示例。

我还遇到了yaml/json文件来描述这一点。但是我还没有找到在应用程序中放置这个文件的位置，以便swagger-ui使用它。

Answer 1

终于找到了

使用@operation和@schema，可以定义请求体中作为输入所需的类。这将显示为Swagger-UI中的示例json结构。不需要其他配置。

@RouterOperations({
            @RouterOperation(
                    path = "/data", beanClass = MyHandler.class,  beanMethod = "getData",
                    operation = @Operation(
                            operationId = "opGetData",
                            requestBody = @RequestBody(required = true, description = "Enter Request body as Json Object",
                                                content = @Content(
                                                        schema = @Schema(implementation = ApiRequestBody.class))))),
            @RouterOperation(path = "/allData", beanClass = MyHandler.class, beanMethod = "getAllData")})

@Bean
    public RouterFunction<ServerResponse> route(MyHandler myHandler) {

        return RouterFunctions
                .route(RequestPredicates.POST("/data").and(RequestPredicates.accept(MediaType.APPLICATION_JSON)), myHandler::getData)
                .andRoute(RequestPredicates.GET("/allData").and(RequestPredicates.accept(MediaType.APPLICATION_JSON)), myHandler::getAllData);
    }