Как описать карту с ключами объекта в 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.

Самое большее, что вы можете сделать, это определить вашу хэш-карту как просто type: object, что означает произвольный объект.