OpenAPI:如何验证示例?

时间:2019-02-15 16:12:09

标签: jsonschema openapi

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

是否可以使用OpenAPI 3规范执行相同的操作?

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

任何人都知道一种简单的解决方案来对照其模式检查所有示例吗?

1 个答案:

答案 0 :(得分:2)

官方的OpenAPI工具不会验证引用的示例,尤其是因为官方规范甚至不要求示例与模式匹配(请参阅:OpenAPI specification),它仅声明其“应该”匹配:

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

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

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