如何在OpenAPI（Swagger）中记录动态查询参数名称？

Question

有什么方法可以记录下面的查询吗？

GET api/v1/users?name1=value1&name2=value

其中查询参数名称是动态的，将从客户端接收。

我正在使用最新的Swagger API。

Answer 1

@Helen的答案甚至可以完美地使用Spring用户界面库。

依赖性：

 <dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>1.1.43</version>
 </dependency>

在 API 函数中，添加以下参数：

 @Parameter(in=ParameterIn.QUERY,
            name="params", style=ParameterStyle.FORM,
            schema=@Schema(type="object"), explode=Explode.TRUE,
            example="") String paramsObj

Answer 2

自由格式的查询参数可以用OpenAPI 3.x描述，但不能用OpenAPI 2.0 (Swagger 2.0)描述。该参数必须具有序列化方法为< code>style: form和< code>explode: true的< code>type: object。对象将被序列化为< code >？prop1 =值1

openapi: 3.0.3
...
paths:
  /users:
    get:
      parameters:
        - in: query

          # Arbitrary name. It won't appear in the request URL, but will be used
          # in server & client code generated from this OAS document.
          name: params

          schema:
            type: object
            # If the parameter values are of specific type, e.g. string:
            additionalProperties:
              type: string
            # If the parameter values can be of different types
            # (e.g. string, number, boolean, ...)
            # additionalProperties: true

          # `style: form` and `explode: true` is the default serialization method
          # for query parameters, so these keywords can be omitted
          style: form
          explode: true

Swagger UI 3.15.0和Swagger编辑器3.5.6支持自由格式的查询参数。在参数编辑器中，以JSON对象格式输入参数名称和值，例如{"prop1"："vale1"，"prop2"："vale2"}。“试用”将作为参数=value查询参数发送它们：

但不确定Codecen支持。