Java或JavaScript库,用于从Swagger,RAML或API Blueprint生成HTML

时间:2014-10-24 16:02:04

标签: java html swagger apiblueprint raml

问题:

我正在搜索Java或JavaScript(或者Scala)的库,它能够生成Swagger,RAML或API Blueprint输入的HTML表示。

背景

我们的想法是将其用作(Play Framework)Web应用程序的一部分,作为API目录。 API目录的用户将添加API规范,并生成/显示生成的HTML表示。

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

此外,如果相同(或相关的另一个)库提供了一个很好的HTML编辑器(Swagger,RAML,API Blueprint等),在编辑时支持用户,它将提供额外的价值。

3 个答案:

答案 0 :(得分:2)

Swagger提供了一套工具来完成它。

Swagger-Core可让您根据Play代码生成Swagger文档。这是在运行时完成的,并会随着应用程序的更改而改变。

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

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

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

答案 1 :(得分:0)

有一些工具可以从API蓝图生成HTML,其中一个在Coffeescript中,称为Aglio。您可以在此处查看所有工具:

http://apiblueprint.org/

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

答案 2 :(得分:0)