Swagger OpenAPI添加额外的示例,而不必重新定义默认示例
在OpenAPI3中,我有一个引用现有模型的reponses块Swagger OpenAPI添加额外的示例,而不必重新定义默认示例,swagger,swagger-ui,openapi,Swagger,Swagger Ui,Openapi,在OpenAPI3中,我有一个引用现有模型的reponses块 responses: 200: description: successful operation content: application/json: schema: $ref: '#/components/schemas/MyModel' 因为MyModel包含example字段,所以我在UI中得到了很好的示例响应。可爱 我想在此端点上
responses:
200:
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/MyModel'
因为MyModel包含example
字段,所以我在UI中得到了很好的示例响应。可爱
我想在此端点上添加一些其他示例。我可以创建一个
examples
字段(在application/json
下面),并通过一个漂亮的UI下拉列表显示多个示例。
但是,如果我这样做,我就失去了默认示例,必须重新定义默认示例以供用户查看。e、 我只能定义一组全新的例子,而不是添加一个新的 在定义示例块时,有没有办法直接包含默认示例?
我希望这样的事情能奏效:
examples:
default:
$ref: '#/components/schemas/MyModel'
myOtherExample:
value: {"A": "B"}
它编译正常,但显示一个空示例
在定义示例块时,有没有办法直接包含默认示例
这是不受支持的。如果OpenAPI定义中提供了自定义的示例
或示例
,则Swagger UI将使用这些自定义示例而不是自动生成的示例
用户仍然可以在Swagger UI的Model/schema选项卡上的模式文档中看到默认值