使用 x-example 控制 Developer Portal 中显示的示例

OpenAPI 不支持在参数上使用 example 属性,仅支持在请求和响应对象及其属性上使用此类属性。为使 API 开发者能够控制门户网站中显示的示例,可以在 OpenAPI 参数中使用 x-example

在此示例中,不能使用 example(因为 OpenAPI 规范不支持 example),但可以使用 x-example

 - name: city
   in: query
   required: false
   type: string
   maxLength: 50
   description: "Location"
   x-example: "New York"

在规范设置和允许的范围内支持 example 属性。如果未找到 example,那么在规范设置和允许的范围内支持 default。如果已找到 x-example 属性,那么将支持该属性;如果未找到该属性,那么将生成与模式匹配的随机示例。

如果规范允许您使用 example,那么应该使用 example(它优先于 x-example)。

时间戳记图标 上次更新时间:2019-06-21