是否有任何静态代码分析工具来验证 API REST 指南？

Posted 2023-02-21

【中文标题】是否有任何静态代码分析工具来验证 API REST 指南？

【英文标题】：Is there any Static Code Analysis Tool to verify API REST guidelines?

【发布时间】：2020-11-20 12:08:05

【问题描述】：

提前感谢您分享您的想法和意见。

我们知道最近发布了许多 API 的 REST 指南。我使用下面的代码进行内部代码审查。

https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md

有什么方法可以根据指南自动执行代码审查？是否有任何特定的工具？

如果不是，是否可以为任何可用工具配置自定义规则以检查指南？

非常感谢任何意见。

谢谢，尼尔

【问题讨论】：

我怀疑遵循真正 REST 架构原则的应用程序是否会成为静态代码分析工具或 linter 的有效目标。然而，对于所有那些本质上是纯 RPC 的伪“REST”服务，这些工具可能是可用的，尽管如前所述，它们根本不应该被称为 REST。 REST 应该通过遵守少数架构约束（例如无状态、可缓存性和专注于 HATEOAS）来实现完全解耦。

【参考方案1】：

我正在使用 SwaggerHub，它内置了标准化检查，但我正在使用 Spectral 来根据我们的标准自动审查/检查。 API handyman/Arnaud Lauret 有一个 excellent series 说明如何执行此操作以及如何将频谱用作“Augmented API reviewer”