使用API​​蓝图

Question

是否可以使用Restful API代码中的API Blueprint工具生成/生成文档？如果可以，如何使用此工具提供帮助？

Answer 1

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

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

希望这确实澄清。