rest - 验证 OpenAPI 对 REST 设计最佳实践的合规性

Question

我们正在使用 Swagger 从源代码生成 API 文档。我现在想知道是否有任何工具可以自动检查生成的 OpenAPI 文档(= Swagger JSON)是否符合 RESTful API 设计最佳实践。

例如，Zalando 为 REST 设计定义了一个公开可用的指南。在我看来，这些指南中有许多规则可以根据 OpenAPI 规范自动检查:

“不要打破向后兼容性”可以在 OpenAPI 时检查
比较不同版本的文档。

“始终将 JSON 对象作为顶级数据结构返回以支持
可扩展性”

“Keep URLs Verb-Free”如果与
字典。

…

到目前为止，我只找到了检查 OpenAPI 文档完整性和命名约定的工具。有人知 Prop 有更高级规则的工具吗？

更新:

同时，我找到了一个名为 Zally ( https://github.com/zalando-incubator/zally ) 的工具。该工具检查是否违反了 Zalando 的 REST-Api 指南。配置或扩展相当容易。

Answer 1

其中一些可以作为规则添加到 openapilint .向后兼容性检查需要比较两个规范版本以寻找差异，这有点复杂。