从Java云端点生成API文档

Question

我正在寻找一种高效的方式，从Cloud Endpoint（Java）生成的文件中生成可读格式的API文档。生成的文件可以是以下两种之一： - my_api.api - my_api*.discovery

需要生成如下所示的内容： - https://github.com/kevinrenskers/raml2html#example-output Swagger、API blueprint和RAML都是不错的选择，但似乎不太适合端点生成的API描述文件。

您使用的是哪些方法？

- mabruneau

Answer 1

很抱歉，目前我们（Apiary）没有提供任何API Blueprint的代码生成工具。

如果你想从代码中生成API描述，那么API Blueprint可能不是最好的选择，因为我们认为它应该代表参与API设计生命周期的所有人之间的合同。这也是我们构建测试工具Dredd的原因--https://github.com/apiaryio/dredd 使用Dredd，您可以测试API实现是否与蓝图匹配。如果蓝图是从实现中生成的，那么这将没有多大意义。

希望这能澄清问题。

- Vincenzo