Swagger 3 : schema for dictionary of dictionaries

Question

我想建模一个模式，其中响应是字典:

{
  'id1': {
    'type': 'type1',
    'active': true,
  }, 
  'id2': {
    'type': 'type2',
    'active': false,
  },
  ... 
  ... 
}

我已经定义:

components:
  schemas:
    accountData:
      type: object
      required:
        - type
        - active
      properties:
        type:
          type: string
        active:
          type: boolean

    accounts:
      type: object
      additionalProperties:
        type: object
        properties:
          account-id:
            type: object
            $ref: '#/components/schemas/accountData'

现在我想定义“#/components/schemas/accounts”，它是“#/components/schemas/account”的重复字典。

我对 OpenApi 3 很陌生，我无法弄清楚如何去做。

Answer 1

你快到了。 additonalProperties 中指定的模式对应于<key, value>中的值类型字典。在您的示例中，值为 accountData对象，所以你应该使用:

components:
  schemas:
    ...

    accounts:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/accountData'