使用 API 蓝图通过代码生成 API 文档

Question

是否可以使用 Restful API 代码中的 API Blueprint 工具来 produce/generate 文档，如果可以，如何使用此工具有帮助吗？

Answer 1

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

的原因

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

希望这能澄清。