2015-12-09 18 views
4

我已经通过swagger editor手动创建了YAML文件(和JSON文件)。Swagger UI/Editor like page - 添加到我的网站

现在我想将自动生成的超酷网页从swagger-editor工具嵌入到我的网站中,以便用户可以通过我的API进行阅读和测试(通过“尝试此操作”按钮)。

我不想让大家为我生成任何代码,我也不需要它自动更新文档(YAML或其他)。我会在需要时手动更新我的静态YAML/JSON文件。 Swagger支持这种功能吗?这是否与在Swagger编辑器工具栏中的“生成客户端”有关? 我正在寻找一些html/js/css文件,这些文件可能会加载静态YAML文件并生成类似于swagger-editor的正确页面的东西。 顺便说一句,我使用Apache Web服务器(不是那么重要)。

谢谢!

编辑:我正在寻找客户端 - 一些js/css/html可以添加上述要求,我不介意再次生成它(每当我将改变我的YAML文件/我的REST API)

回答

5

那么, 我找到了我正在寻找的工具,它是swagger-ui。 这看起来并不像swagger-editor右侧的UI,但它满足了我的要求 - 它仅在静态文件中解析我的JSON文件(我手动编写为YAML)在客户端在线,无需服务器端工作,只提供页面)。

无论如何,谢谢!

编辑:我发现越来越多的人有兴趣在以下link

EDIT2编辑View解决方案: 我已经添加一个简短肮脏的解决方法预览仅招摇编辑器的相关部分。您可以看到更改here。 ,您可以尝试:

  1. 克隆my forked回购:git clone http://github.com/itayB/swagger-editor.git
  2. cd swagger-editor
  3. npm install
  4. npm start

请注意:此预览显示文件规范,文件输出/ default.yaml。 我只做了一些视图更改,所有编辑器逻辑仍在后面运行。

干杯

+1

谢谢确认这个。我试图做同样的事情,并认为swagger-ui是我正在寻找的工具。 – andymal

+0

@andymal是的,只要按照他们在github上的指示..(只需要第一步) - 克隆项目,使用'dist'目录并复制你的json文件。您可能需要编辑索引。html文件与json文件的路径,如果你把它放在不同的地方.. – ItayB

+0

在20分钟内启动并运行。多么酷的项目!我所要做的只是将index.html指向我生成的json文件,并且它已启动并正在运行。太好了! – andymal