只有丑陋的HTML页面作为下载(HTML,HTML 2和动态都丑陋),但该网站,例如.编辑https://app.swaggerhub.com/apis/{user}/{project}/{version}
(和许多其他!)提供漂亮的HTML界面.如何下载这个漂亮的HTML?
完整和自主的HTML代码(文件或压缩文件)。
我有一个良好有效的API的swagger.yaml
或swagger.json
文件,因此另一种解决方案是用我的API描述文件运行一个开源(即插即用!)工具。
美女:
x1c 0d1x的数据
丑陋:
的
2条答案
按热度按时间uwopmtnx1#
你截图上的“漂亮界面”是**Swagger UI**。它是免费开源的。在http://petstore.swagger.io上有一个演示,你可以从一个URL加载你自己的YAML/JSON文件,看看它们是如何渲染的。
在本地使用Swagger UI:
1.转到https://github.com/swagger-api/swagger-ui并以ZIP格式下载存储库:
x1c 0d1x的数据
1.编辑
dist\index.html
文件并更改行字符串
指向Swagger .json或.yaml文件的URL,例如:
型
1.(可选)在
dist\index.html
中的SwaggerUIBundle
初始化代码中添加/更改其他configuration parameters。1.在浏览器中打开
dist\index.html
文件以预览API文档。**注意:**如果spec没有加载或“尝试”不起作用,您可能需要在您的服务器上启用CORS。请参阅https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/cors.md和https://enable-cors.org。
1.将
dist
文件夹中的文件上传到您的服务器-现在您也有了漂亮的API文档!或者,SwaggerHub(您提到的)为Swagger规范提供云托管,并集成了Swagger UI。您可以在那里导入Swagger .json/.yaml文件,并将API文档托管在SwaggerHub上。free plan可用。
rhfm7lfc2#
Modern Swagger-UI at https://github.com/swagger-api在Readme上说
如果你正在寻找普通的HTML/JS/CSS,download the latest release和复制
/dist
文件夹的内容到您的服务器。要在那里安装OpenAPI JSON,请更改
swagger-initializer.js
这一行的URL,字符串
旧答案
感谢swagger-ui/issues上的@tleyden提供的好线索!
使用此项目的索引和
assets
文件夹,https://github.com/okfn-brasil/swagger-ui-html