【问题标题】:OpenAPI: how to validate examples?OpenAPI:如何验证示例?
【发布时间】:2019-07-09 19:41:19
【问题描述】:

当您呈现文档时,RAML 会自动使用相应的架构验证包含的示例。

有没有办法对 OpenAPI 3 规范做同样的事情?

codekie/swagger-examples-validator 目前仅支持 OpenAPI 2。

任何人都知道一个简单的解决方案,可以根据他们的架构检查所有示例吗?

【问题讨论】:

  • SwaggerEditor 不为您做这些吗?
  • @MCMatan 至少免费版本似乎没有检查示例。但是 codekie/swagger-examples-validator 现在部分支持 OpenAPI 3 - 检查 examples 属性,但当前版本似乎无法识别单个 example 属性
  • codekie/openapi-examples-validator(以前称为 swagger-examples-validator)现在支持单数 example-property。
  • 我无法验证任何示例...codekie/openapi-examples-validator 总是返回:“验证示例模式找到示例:0 没有找到模式的示例:0 找到的示例总数:0 否发现错误。”

标签: validation jsonschema openapi


【解决方案1】:

官方 OpenAPI-tools 不验证引用的示例,特别是因为官方规范甚至不要求示例匹配架构(参见:OpenAPI specification),它只声明它“应该”匹配:

媒体类型示例。每个示例对象都应该匹配媒体 类型和指定的架构(如果存在)。

您将不得不依赖第三方工具。

一个选项是codekie/openapi-examples-validator,它现在支持 OpenAPI 3 规范

【讨论】:

  • 虽然此链接可能会回答问题,但最好在此处包含答案的基本部分并提供链接以供参考。如果链接页面发生更改,仅链接答案可能会失效。 - From Review
猜你喜欢
  • 2020-05-29
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2021-12-13
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2022-01-16
相关资源
最近更新 更多