0

问题：

我正在搜索 Java 或 JavaScript（或者可能是 Scala）中的库，它能够生成 Swagger、RAML 或 API 蓝图输入的 HTML 表示。

背景：

这个想法是将其用作（Play Framework）网络应用程序的一部分，用作 API 目录。API 规范将由 API 目录的用户添加，并生成/显示生成的 HTML 表示。

如果 API 规范存根也可以使用 Java API 创建，这将提供额外的价值。API 目录 Web 应用程序有一个数据模型，我想在生成 API 存根时使用它。

此外，如果同一个（或相关的另一个）库提供了一个很好的 API 规范语言（Swagger、RAML、API 蓝图等）的 HTML 编辑器，在编辑时支持用户，它将提供额外的价值。

4

3 回答 3

2

Swagger 提供了一套工具来做到这一点。

Swagger-Core 将使您能够从您的 Play 代码生成 Swagger 文档。这是在运行时完成的，并且会随着应用程序的变化而变化。

Swagger-UI 将读取此类文档并以 HTML 格式显示它们。它还允许您执行操作并在需要时与安全机制集成。UI 可以定制为具有您的应用程序的外观和感觉（就像迄今为止许多人所做的那样）。

Swagger-Editor 允许使用 HTML 格式的文档的交互式并排视图直接编辑 Swagger 文档。

Swagger-Codegen 可以获取这样的文档并生成客户端和服务器代码。您可以自定义模板以满足您的需求。

于 2014-10-24T17:16:53.330 回答
0

有多种工具可用于从 API 蓝图生成 HTML，其中之一位于 Coffeescript 中，称为 Aglio。您可以在此处查看所有工具：

http://apiblueprint.org/

此外，Apiary是一种使用 API 蓝图的服务，可用于编辑和托管生成的文档，与 Github 连接以从提交中自动生成，为团队和企业提供一些模拟 API 和其他一些很酷的东西。如果您想要为您的 API 文档提供可靠的服务，您可以查看它。

于 2014-10-24T16:29:18.633 回答
0

对于 RAML，您有： - https://github.com/kevinrenskers/raml2html - https://github.com/mikestowe/php-raml2html

试试看；）

于 2014-12-17T18:23:57.997 回答