swagger-2.0 - Swagger 编辑器字典参数定义

Question

我正在努力解决如何在 swagger 编辑器中定义字典类型的问题。我的 POST 方法的参数之一称为“角色”，它的值是一个字典，其中键是电子邮件地址，值是一个整数。

Answer 1

Swagger 支持键为字符串的关联数组/ HashMap /字典。字典是通过使用 object 架构和 additionalProperties 关键字来定义的，该关键字指定键/值对的值类型。没有提到 key 类型，因为 key 始终是字符串。

所以一个字符串到整数的字典可以定义为:

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