我有一个OpenAPI文档,其中端点使用oneOf
作为请求体(这个端点有两个可能的不同模式)。在Swagger中,我只能看到显示端点的模式之一,我理解这是正常的。如何显示其他模式或链接它,以便能够轻松地访问它?
发布于 2022-08-05 07:14:04
Swagger中的架构选项卡显示oneOf
和anyOf
模式的所有子模式:
要在示例值选项卡上反映备选方案,需要手动定义多个请求体examples
,每个模式一个。这将为Swagger添加一个下拉列表,这样用户就可以在示例之间切换。
paths:
/something:
post:
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Foo'
- $ref: '#/components/schemas/Bar'
examples:
fooExample:
summary: An example of Foo data
value:
foo: hello
barExample:
summary: An example of Bar data
value:
bar: 123
我认为有一个现有的特性请求可以自动为oneOf
/anyOf
子模式生成多个示例,但我找不到它。您可以随意地提交一个特性请求。
https://stackoverflow.com/questions/73238665
复制相似问题