如何在OpenAPI/Swagger中描述带有对象键的地图？ [英] How to describe a map with object keys in OpenAPI/Swagger?

问题描述

在我的rest API中，我想使用散列图Map<Foo, List<Bar>>，其中Foo和Bar是用户定义的类。如何在OpenAPI(Swagger)中描述这样的地图？

推荐答案

OpenAPI(Swagger)仅支持字符串键为：

的映射

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

   ^^ key is a string
}

不能用Map<Foo, Bar>这样的非字符串键来定义映射。您可以在OpenAPI规范库中提交功能请求：https://github.com/OAI/OpenAPI-Specification/issues。

您最多只能将哈希图定义为type: object，这表示任意对象。

这篇关于如何在OpenAPI/Swagger中描述带有对象键的地图？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！