繁体   English   中英

Java或JavaScript库可从Swagger,RAML或API蓝图生成HTML

[英]Java or JavaScript library to generate HTML from Swagger, RAML or API Blueprint

问题:

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

背景:

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

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

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

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

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

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

Swagger-Editor可以直接编辑Swagger文档,并具有HTML格式的交互式文档并排视图。

Swagger-Codegen可以获取此类文档,并生成客户端和服务器代码。 您可以自定义模板以适合您的需求。

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

http://apiblueprint.org/

此外, Apiary是使用API​​蓝图的服务,可用于编辑和托管生成的文档,与Github挂钩以从提交中自动生成,为团队和企业提供一些模拟API和其他一些不错的东西。 如果您想为API文档提供可靠的服务,则可以查看。

对于RAML,您可以:-https: //github.com/kevinrenskers/raml2html-https : //github.com/mikestowe/php-raml2html

试试看吧;)

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM