swagger 3：字典的模式

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'