如何在 OpenAPI/Swagger 中用对象键描述映射？

Question

在我的 REST API 中，我想使用哈希图，Map<Foo, List<Bar>>其中Foo和Bar是用户定义的类。如何在OpenAPI（Swagger）中描述这样的地图？

Answer 1

OpenAPI (Swagger) 仅支持带有字符串键的映射，例如：

{
  "en":  "Hello",
  "fr":  "Bonjour"

   ^^ key is a string
}

无法使用非字符串键定义映射，例如Map<Foo, Bar>。您可以在 OpenAPI 规范存储库中提交功能请求： https: //github.com/OAI/OpenAPI-Specification/issues。

您最多可以将哈希图定义为 just type: object，这意味着任意对象。