如何在多个堆栈之间强制执行API契约？

Question

对于构建在各种技术栈之上的系统，包括静态和动态类型语言，在实践中有什么方法可以发布和执行API协议？

一些wiki文档会随着时间的推移而过时，所以我想知道在工业中使用的各种方法是什么？

Answer 1

实现这一目标的主要方式有两种：

1. 编写兼容性测试套件，该套件调用API并验证实现是否符合API契约所要求的属性。理想情况下，这应该是一个自动化测试，以便测试是可重复的和一致的，但在某些情况下，您可以编写一个证书测试，在允许集成人员连接到生产系统之前，他们需要运行这些测试。
2. 编写一个模式文件(例如XSD、JSON )，实现可以与它们的实现运行。在许多情况下，客户端可以使用模式文件自动生成客户端SDK，服务器可以使用模式文件来生成实现存根。但是，即使不是自动生成模式，模式也很有用；大多数模式语言都有验证器，可以根据模式运行示例文档来检查文档是否与模式匹配。