2017-09-29 83 views
1

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

例如Zalando已经在这些准则所定义的REST设计一个公开的指导方针在我看来有可自动检查基础上,OpenAPI的规格很多规则:

  • “不要向后打破兼容性“可以在不同版本的OpenAPI 文件进行比较时进行检查。
  • “总是返回JSON对象为顶级数据结构以支持 扩展”
  • ‘保持网址动词 - 免费’可能可能的,如果有 词典相比,检查。
  • ...

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

UPDATE:

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

回答

0

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