Несколько примеров тела в swagger

Question

Ive метод, который принимает объект. Объект является динамическим и может быть построен по 5 разным способом в зависимости от того, сколько у него детей и какого типа объекта он есть. Я хочу, чтобы было ясно, как построить этот объект, а также показать, какие типы детей могут использоваться вместе.

Пример A: новый Майкл (id, name, Type.A, новая Sara (id, name, ChildrenType.B));

Пример B: новый Sandra (id, name, Type. C, новый Pheno (id, name, ChildrenType.D), новый Leo (id, name, ChildrenType.E));

Как я уже говорил, объект является dymanic и может быть построен по-разному в зависимости от того, какой тип объекта имеет и сколько у него детей.

Я думал, что лучший способ показать все это - это иметь 5 разных примерных bodys в swagger. Но idk, если это возможно? Это и является ли это лучшим решением для этого?

И им, используя java, если он делает какой-либо diff, какие языки я использую.

Спасибо!

Answer 1

Вы можете определить только один пример для типа mime. Однако вы можете использовать externalDocs для перенаправления на другую страницу со всеми вашими примерами.

Answer 2

Если у вас есть общий интерфейс для полезной нагрузки, вы можете использовать дискриминатор для выбора различных конкретных типов, которые могут быть созданы.