验证OpenAPI与REST设计最佳实践的合规性

时间:2017-09-29 08:23:42

标签: rest swagger openapi

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

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

  • OpenAPI时可以检查“不要破坏向后兼容性” 比较不同版本的文件。
  • “始终将JSON对象作为支持的顶级数据结构返回 扩展“
  • 如果与之相比,可以检查“保持网址无动词” 字典。
  • ...

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

更新:

与此同时,我找到了一个名为Zally(https://github.com/zalando-incubator/zally)的工具。该工具可检查Zalando的REST-Api指南是否存在违规行为。它很容易配置或扩展。

1 个答案:

答案 0 :(得分:1)

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