在swagger留档中使用对象类型查询参数

Question

我有一个GET路由，我想在其中将url中的对象参数编码为查询字符串。

在编写 swagger 文档时，我基本上收到不允许我在查询类型参数中使用架构/对象类型的错误：

paths:
  /mypath/:
    get:
      parameters
        - in: path
          name: someParam
          description: some param that works
          required: true
          type: string
          format: timeuuid #good param, works well
        - $ref: "#/parameters/mySortingParam" #this yields an error

parameters:
  mySortingParam
    name: paging
    in: query
    description: Holds various paging attributes
    required: false
    schema:
      type: object
      properties:
        pageSize:
          type: number
        cursor:
          type: object
          properties:
            after:
              type: string
              format: string

具有对象值的请求查询参数将在实际请求中编码。

即使 swagger在屏幕顶部显示错误，对象也会在 swagger UI 编辑器中正确呈现，但是该错误浮动在文档顶部。

Answer 1

这是可能的，只是不适用于OpenAPI 2.0。OpenAPI 3.0在这里描述了这是如何实现的：

https://swagger . io/docs/specification/descripting-parameters/

parameters:
- in: query
  name: filter
  # Wrap 'schema' into 'content.<media-type>'
  content:
    application/json:  # <---- media type indicates how to serialize / deserialize the parameter content
      schema:
        type: object
        properties:
          type:
            type: string
          color:
            type: string

同时，您可以将查询参数作为普通的旧字符串类型，然后手动执行序列化，然后根据需要设置查询参数。这就是我一直在做的事情，直到Swagger UI完全支持OpenAPI 3.0。

Answer 2

现在，OpenAPI 3.0可以做到这一点。

parameters:
  - in: query
    name: values
    schema:
      type: object
      properties:
        genre_id: 
          type: integer
        author_id:
          type: integer
        title:
          type: string
      example:
       {
         "genre_id": 1,
         "author_id": 1
       }
    style: form
    explode: true

在这里，您可以使用 style 和分解关键字来指定应如何序列化参数。

< li >样式定义如何分隔多个值。可能的样式取决于参数位置——路径、查询、标题或cookie。 < li>explode (true/false)指定数组和对象是否应为每个数组项目或对象属性生成单独的参数。

对于上面的示例，url 将是：

https://ebookstore.build/v1/users/books/search?genre_id=1&author_id=1 

有关使用OpenAPI v3描述参数和参数序列化的更多信息，请参阅此处。

Answer 3

我不认为您可以使用“对象”作为Swagger规范中的查询参数，因为查询参数仅支持原始类型（https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types）