Spring WebFlux 功能路由器 OpenAPI UI

Question

我想创建OpenAPI UI规范，在静态编程语言上使用Spring WebFlux功能路由器。Spring Boot v.2.5.2，springdoc-openapi v.1.5.9。这是我的路由器类：

@Configuration
class UserServiceRouter {

    @Bean
    @RouterOperations(
        RouterOperation(
            path = "/user/{id}",
            method = [RequestMethod.GET],
            beanClass = UserService::class,
            beanMethod = "getUserCredentialsById",
        operation = Operation(
            parameters = [Parameter(
                style = ParameterStyle.SIMPLE,
                explode = Explode.FALSE,
                `in` = ParameterIn.PATH
            )]
        )
        ),
        RouterOperation(
            path = "/user/profile/{id}",
            method = [RequestMethod.GET],
            beanClass = UserService::class,
            beanMethod = "getUserProfileById",
        operation = Operation(
            parameters = [Parameter(
                style = ParameterStyle.SIMPLE,
                explode = Explode.FALSE,
                `in` = ParameterIn.PATH
            )]
        )
    )
    fun userRoute(userServiceHandler: UserServiceHandler) = coRouter {
        ("/user").nest {
            GET("/{id}", userServiceHandler::getUserCredentialsById)
            GET("/profile/{id}", userServiceHandler::getUserById)
        }
    }
}

我想创建一个 GET 查询，如

http://localhost:8080/user/1

其中1是我想要的用户ID。

但我的OpenAPI的UI仍然尝试使用GET参数创建查询

http://localhost:8080/user/{id}?id=1

这显然会导致错误400。很高兴知道我的@RouterAction应该如何正确配置。

Answer 1

路径变量的正确配置如下所示（为了简洁起见，我在这里只留下了一个GET查询）：

@Bean
@RouterOperations(
    RouterOperation(
        path = "/user/{id}",
        method = arrayOf(RequestMethod.GET),
        beanClass = UserService::class,
        beanMethod = "getUserCredentialsById",
        operation = Operation(
            operationId =  "getUserCredentialsById",
            method = "GET",
            parameters = [
                Parameter(
                    name = "id",
                    `in` = ParameterIn.PATH,
                    style = ParameterStyle.SIMPLE,
                    explode = Explode.FALSE,
                    required = true
                )]
        )
    )
)
fun userRoute(userServiceHandler: UserServiceHandler) = coRouter {
    path("/user")
        .nest {
            GET("/{id}", userServiceHandler::getUserCredentialsById)
        }
}

请点击此处查看规格。要点:

< li >操作ID是必需的 < Li > < code > Operation < code > parameters[]中的默认值是“查询参数”而不是“路径参数”，我们应该显式地指向参数名称(< code>name = "id")，以便覆盖默认行为。 < li >如问题中所述，< code >参数in。PATH也是必需的。