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

Question

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

在编写 swagger 文档时，我基本上会遇到不允许我使用 schema 的错误。/object输入 query类型参数:

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 编辑器中正确呈现，但是该错误 float 在文档顶部。

Answer 1

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