首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >验证OpenAPI是否符合REST设计最佳实践

验证OpenAPI是否符合REST设计最佳实践
EN

Stack Overflow用户
提问于 2017-09-29 08:23:41
回答 1查看 1.4K关注 0票数 4

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

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

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

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

更新:

与此同时,我发现了一个名为Zally (https://github.com/zalando-incubator/zally)的工具。这个工具检查是否违反了扎兰多的REST-Api准则。它相当容易配置或扩展。

EN

回答 1

Stack Overflow用户

发布于 2017-11-29 03:23:31

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

票数 1
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/46484700

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档