如何将API Blueprint与API源代码同步?

时间:2016-03-16 07:46:59

标签: php api swagger apiblueprint raml

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

我想知道的是,是否有任何技术/框架/代码或任何要在API和API蓝图之间同步的内容?

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

非常感谢。

1 个答案:

答案 0 :(得分:4)

不幸的是,我们(Apiary)目前还没有为API Blueprint提供任何代码同步工具。

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

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

希望它澄清。