在Linux系统中Swagger UI如何展示API文档

在Linux系统中，Swagger UI可以通过以下步骤展示API文档：

安装Node.js和npm

首先，确保你的Linux系统上已经安装了Node.js和npm。如果尚未安装，可以参考官方文档进行安装。

下载并解压Swagger UI

你可以从Swagger的GitHub仓库下载最新版本的Swagger UI，并解压到你的服务器上的适当目录。

配置Swagger UI

1. 进入Swagger UI目录：

   cd /path/to/swagger-ui
   

2. 安装Express（如果使用）：

   npm install express --save
   

3. 修改index.html文件：

   编辑index.html文件，通常需要修改以下部分来指定你的API文档的URL：

   <script>
     window.onload = function() {
       // Begin Swagger UI call region
       const ui = SwaggerUIBundle({
         url: "http://your-api-docs-url", // 替换为你的API文档URL
         dom_id: '#swagger-ui',
         deepLinking: true,
         presets: [
           SwaggerUIBundle.presets.apis,
           SwaggerUIStandalonePreset
         ],
         plugins: [
           SwaggerUIBundle.plugins.DownloadUrl
         ],
         layout: "StandaloneLayout"
       });
       // End Swagger UI call region
       window.ui = ui;
     }
   </script>
   

启动Web服务器

你可以使用http-server来快速启动一个Web服务器来提供Swagger UI文件。如果你已经安装了Node.js和npm，可以全局安装http-server：

npm install -g http-server

然后在Swagger UI目录中启动服务器：

http-server

默认情况下，服务器会在端口8080上运行。你可以通过访问http://localhost:8080来查看Swagger UI。

使用Docker部署

另一种更简单的方法是使用Docker来部署Swagger UI和Swagger Editor。你可以从Docker Hub拉取官方镜像，并运行容器：

# 拉取Swagger Editor镜像
docker pull swaggerapi/swagger-editor:v4.6.0

# 拉取Swagger UI镜像
docker pull swaggerapi/swagger-ui:v4.15.5

# 运行Swagger Editor容器
docker run -d -p 38080:8080 swaggerapi/swagger-editor:v4.6.0

# 运行Swagger UI容器
docker run -d -p 38081:8080 swaggerapi/swagger-ui:v4.15.5

然后，你可以通过访问http://localhost:38081来查看Swagger UI。

配置Spring Boot项目（如果使用Spring Boot）

如果你在Spring Boot项目中使用Swagger，可以通过添加springfox-swagger2和springfox-swagger-ui依赖来集成Swagger。然后，配置一个配置类来启用Swagger，并访问http://localhost:8080/swagger-ui.html来查看API文档。

以上步骤应该可以帮助你在Linux系统中成功部署和展示Swagger UI的API文档。