从Java Cloud Endpoint生成API文档

Question

我正在寻找一种从云端点（Java）生成的文件中以可读格式生成API文档的有效方法。生成的文件是： - my_api.api - my_api * .discovery

看起来像这样的东西： - https://github.com/kevinrenskers/raml2html#example-output

Swagger，API蓝图和RAML都是不错的选择，但似乎不适应端点生成的API描述符文件。

您使用的是哪种方法？

Answer 1

不幸的是，我们（Apiary）目前还没有为API Blueprint提供任何代码生成工具。

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

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

希望它澄清。