从 Java Cloud Endpoint 生成 API 文档

Posted 2023-02-19

【中文标题】从 Java Cloud Endpoint 生成 API 文档

【英文标题】：Generating API documentation from Java Cloud Endpoint

【发布时间】：2014-10-01 00:33:31

【问题描述】：

我正在寻找一种有效的方法来从 Cloud Endpoint (Java) 生成的文件中生成可读格式的 API 文档。生成的文件是： - my_api.api - my_api*.discovery

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

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

你用的是什么方法？

【参考方案1】：

很遗憾，我们（Apiary）目前实际上并未为 API 蓝图提供任何代码生成工具。

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

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

希望它澄清。