用于URL查询参数中对象数组的Swagger/OpenAPI规范

Question

假设我有一个URL，其路径为:？filter[id]=1&filter[name]=bob&order[][name]=asc&order[][age]=desc

如何将其转换为大摇大摆的文档，具体地说，将对象数组和数组作为查询参数。

Answer 1

您的示例不是对象数组，而是两个独立的对象参数--filter和order[]，每个参数都使用deepobject样式序列化（OpenAPI 3.0支持）。您可以如下描述这些参数：

openapi: 3.0.2
...

paths:
  /something:
    get:
      # ?filter[id]=1&filter[name]=bob&order[][name]=asc&order[][age]=desc
      parameters:
        - in: query
          name: filter
          schema:
            type: object
            properties:
              id:
                type: integer
                example: 1
              name:
                type: string
                example: bob
          style: deepObject

        - in: query
          name: order[]
          schema:
            type: object
            properties:
              name:
                type: string
                example: asc
              age:
                type: string
                example: desc
          style: deepObject