多个 example-body 大摇大摆

Multiple example-body in swagger

我有一个采用 object 的方法。 object 是动态的,它可以用 5 种不同的方式构造,具体取决于它有多少 children 以及它是哪种类型的 object。我希望清楚地说明如何构建此 object 并显示可以一起使用哪些 children 类型。

示例 A:new Michael(id,name, Type.A, new Sara(id, name, ChildrenType.B));

示例 B:new Sandra(id,name,Type.C, new Pheno(id, name,ChildrenType.D), new Leo(id, name,ChildrenType.E));

正如我之前所说,object 是动态的,可以根据 object 的类型和数量 children 的不同以不同的方式构建。

我认为展示所有这些的最好方式是拥有 5 个不同的示例主体。但是如果可能的话,我知道吗?这是最好的解决方案吗?

我正在使用 java,如果它对我使用的语言有任何影响。

谢谢!

每种 MIME 类型只能定义一个示例。 但是,您可以使用 externalDocs 重定向到包含所有示例的另一个页面。

如果您有有效负载的通用接口,则可以使用鉴别器来选择可以实例化的不同具体类型。