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

时间:2015-12-09 20:32:34

标签: yaml swagger swagger-ui swagger-2.0 swagger-editor

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

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

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

谢谢!

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

2 个答案:

答案 0 :(得分:5)

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

非常感谢!

编辑:我发现更多人对以下link

中的编辑器视图解决方案感兴趣

EDIT2: 我添加了一个简短的脏方法,仅用于预览swagger-editor的相关部分。您可以看到更改here。 你可以尝试一下:

  1. clone my forked repo:git clone http://github.com/itayB/swagger-editor.git
  2. cd swagger-editor
  3. npm install
  4. npm start
  5. 请注意:此预览显示文件spec-files / default.yaml的输出。 我只做了一些视图更改,所有编辑器逻辑仍在后面运行。

    干杯

答案 1 :(得分:1)

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