首页 文章

Swagger UI / Editor like page - 添加到我的网站

提问于
浏览
4

我通过swagger editor手动创建了YAML文件(和JSON文件) .

现在我想将来自swagger-editor工具的酷炫自动生成页面嵌入到我的网站中,这样用户就可以通过我的API实时阅读和测试它(通过“尝试此操作”按钮) .

我不想让swagger为我生成任何代码,我也不需要它自动更新文档(YAML或其他) . 每当我需要时,我都会手动更新我的静态YAML / JSON文件 . 招摇是否支持这种功能?它是否与swagger编辑器工具栏中的“生成客户端”相关?我正在寻找一些可以加载静态YAML文件的html / js / css文件,并生成类似于swagger-editor右侧页面的内容 . 顺便说一下,我正在使用Apache Web服务器(并不重要) .

谢谢!

EDIT: 我很想再次生成它(每当我改变我的YAML文件/我的REST API时)

2 回答

  • 5

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

    不管怎么说,还是要谢谢你!

    编辑:我发现更多的人对以下编辑器视图解决方案感兴趣link

    编辑2:我添加了一个简短的脏解决方法,仅预览swagger编辑器的相关部分 . 您可以看到更改here . 你可以尝试一下:

    • clone my forked repo: git clone http://github.com/itayB/swagger-editor.git

    • cd swagger-editor

    • npm install

    • npm start

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

    干杯

  • 1

    我想你正在寻找swagger-server(https://github.com/BigstickCarpet/swagger-server) .

相关问题