如何将 API 蓝图与 API 源代码同步?

How to synchronize API Blueprint with API source code?

我想使用 PHP 开发 REST Full API。但在我开发真正的 API 之前,我想先创建蓝图作为 API 控制台的文档,假设我正在使用 swagger 或 raml 来完成它。据我了解,API Blueprint 和 API 是不同的源代码。这意味着如果我更改了 API,我也必须更改 API 蓝图,反之亦然。

我想知道的是,API 和 API 蓝图之间是否有任何 technologies/framework/code 或任何同步?

意味着我只需要更改一侧(在 API 或蓝图中),而不仅仅是同步更改另一侧。

非常感谢。

遗憾的是,我们 (Apiary) 目前实际上并未为 API Blueprint 提供任何代码同步工具。

如果您正在寻找一种方法来从代码中生成对您的 API 的描述,那么 API 蓝图可能不是最佳选择,因为我们认为它应该代表两者之间的契约API 设计生命周期中的每个人。这也是我们构建测试工具-Dredd-https://github.com/apiaryio/dredd

的原因

使用 Dredd,您可以测试 API 实施是否与您的蓝图匹配。如果蓝图是从实现中生成的,那就没有多大意义了。

希望说明清楚。