Swagger编辑器字典参数定义

Question

我在如何在swagger编辑器中定义字典类型方面苦苦挣扎。我的POST方法的一个参数称为＆＃39; roles＆＃39;它的值是一个字典，其中键是电子邮件地址，值是整数。

Answer 1

Swagger支持关键数组/ hashmaps / dictionaries，其中键是字符串。通过使用object模式定义字典，additionalProperties关键字指定键/值对的值类型。未提及密钥类型，因为密钥始终是字符串。

因此字符串到整数字典可以定义为：

definitions:
  MyDictionary:
    type: object
    additionalProperties:
      type: integer

默认情况下，Swagger UI 3.x和Swagger Editor 3.x将字典呈现为包含名为additionalProp*的属性：

如果您想要一个更有意义的示例，请在字典架构中添加example：

definitions:
  MyDictionary:
    type: object
    additionalProperties:
      type: integer
    example:
      apples: 5
      oranges: 7