html - Swagger漂亮的HTML代码在哪里？

Question

只有丑陋 HTML 页面可供下载(HTML、HTML2 和动态都丑陋)，但网站，例如。编辑 https://app.swaggerhub.com/apis/{user}/{project}/{version}(以及许多其他!)提供漂亮的 HTML 界面...如何下载这个漂亮的 HTML？

完整且自主的 HTML 代码(文件或文件的 zip)。

我的 API 有一个良好且有效的 swagger.yaml 或 swagger.json 文件，所以另一种解决方案是运行开源(即插即用!)工具与我的 API 描述文件。

---

漂亮的:

丑陋的:

Answer 1

屏幕截图上的“漂亮界面”是 Swagger UI 。它是免费和开源的。 http://petstore.swagger.io 有演示，您可以在其中从 URL 加载自己的 YAML/JSON 文件并查看它们的呈现方式。

在本地使用 Swagger UI:

1. 转到 https://github.com/swagger-api/swagger-ui并以 ZIP 格式下载存储库:

   

2. 编辑dist\index.html文件并更改行

   url: "http://petstore.swagger.io/v2/swagger.json",
   

   到您的 Swagger .json 或 .yaml 文件的 URL，例如

   url: "http://api.mysite.com/swagger.json",
   

3. (可选)添加/更改其他 configuration parameters在SwaggerUIBundle dist\index.html 中的初始化代码.

4. 打开 dist\index.html在浏览器中打开文件以预览您的 API 文档。

   注意:如果规范未加载或“试一试”不起作用，您可能需要在服务器上启用 CORS。参见 https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/cors.md和 https://enable-cors.org .

5. 从 dist 上传文件文件夹到你的服务器的某个地方——现在你也有漂亮的 API 文档了!

或者，SwaggerHub (您提到过)为 Swagger 规范等提供云托管，并集成了 Swagger UI。您可以在那里导入您的 Swagger .json/.yaml 文件，并将您的 API 文档托管在 SwaggerHub 上。 free plan可用。