Swagger-ui 本地设置问题

Question

我正在尝试进行 swagger-ui 的本地设置，我正在关注此链接 Swagger-ui 并按照如何使用它给出的说明进行操作，我已经下载了它的 zip 文件，安装了 nodejs 包并尝试运行以下命令链接中提到的命令，

1. npm Install 
2. gulp

但是当我运行 npm install 时，它给了我错误，即[错误屏幕截图 1 ]

你能指导我如何完成 swagger-ui 本地环境设置吗？ 通过上面提到的链接。

Answer 1

确实没有理由下载并重建 swagger-ui。 最简单的方法可能是获取其中一个版本并在 http 服务器中运行它：

1. 下载https://github.com/swagger-api/swagger-ui/archive/v2.1.4.zip
2. 解压v2.1.4.zip
3. cd swagger-ui-2.1.4\dist
4. http 服务器.

这假设您已经安装了 http-server：

npm install -g http-server

然后你可以访问 swagger-ui http://localhost:8080

Answer 2

如果你想使用 Docker，我发现这个预构建的镜像效果很好：

docker run -d --name swagguer-ui -p 8888:8888 sjeandeaux/docker-swagger-ui

或者使用您自己的默认 API URL：

docker run -d --name swagger-ui -p 8888:8888 -e "API_URL=YOUR_URL" sjeandeaux/docker-swagger-ui

Answer 3

在本地设置 Swagger-UI 所需的步骤：

假设你有 openapi.yml

---

要在本地设置 Swagger-UI，请按照以下步骤操作：

1. 安装必要的软件包：

   npm install
   npm install -g gulp
   

2. 运行Gulp来构建项目：

   gulp
   

3. 捆绑您的 Swagger YAML 文件： 将

   ../functions/src/docs/swagger-v1-kube-sandbox.yml

   替换为 Swagger 文件的路径。

   swagger-cli bundle ../functions/src/docs/swagger-v1-kube-sandbox.yml -o public/openapi.json --type json
   

4. 更新

   index.html

   文件以使用捆绑的 JSON：

   sed -i 's|url: "https://petstore.swagger.io/v2/swagger.json"|url: "./swagger.json"|g' public/index.html
   

5. 如有必要，请重复捆绑和更新步骤：

   swagger-cli bundle ../functions/src/docs/swagger-v1-kube-sandbox.yml -o public/openapi.json --type json
   
   

找到 /swagger-initializer.js 文件并替换你的 openapi.json

window.ui = SwaggerUIBundle({
    url: "./openapi.json",
    dom_id: '#swagger-ui',
    deepLinking: true,
    presets: [
      SwaggerUIBundle.presets.apis,
      SwaggerUIStandalonePreset
    ],
    plugins: [
      SwaggerUIBundle.plugins.DownloadUrl
    ],
    layout: "StandaloneLayout"
  });

6. 安装

   http-server

   为您的 Swagger-UI 提供服务：

   npm install -g http-server
   

7. 导航至

   public

   目录：

   cd public/
   

8. 在端口8000上启动HTTP服务器：

   http-server -p 8000
   

完成这些步骤后，您应该能够通过在网络浏览器中导航到

http://localhost:8000

来本地访问 Swagger-UI。