OpenAPI / Swagger Spec:如何指定整个示例请求正文?

时间:2019-07-16 19:14:33

标签: rest swagger-2.0 openapi

我有一些使用application/json的API,我想使用Open API 2.0 / Swagger Spec 2.0添加示例请求正文。这类似于您可以在此处的responses.200.examples.application/json属性中添加整个示例响应正文的方式:

我一直在浏览规范,只能找到属性值的特定示例,而不是整个请求正文。

这是OpenAPI 3.0规范的标准功能,但是我的工具链尚未迁移到它。这是3.0规范中的示例:

我目前正在为2.0规范考虑三种自定义属性方法:

  • 路径端点对象中的自定义x-requests.examples.application/json属性。这将与responses.200.examples.application/json属性匹配。
  • x-examples.application/json JSON主体参数中的自定义in=body属性。这将与请求架构对象引用更紧密地联系在一起。
  • 路径端点对象中的自定义x-requestBody.content.application/json.examples.default.value。这将与具有原生requestBody属性的OpenAPI 3.0实现相匹配。

是否有使用OpenAPI 2.0 / Swagger 2.0规范执行此操作的标准方法?

0 个答案:

没有答案