如何在Linux上搭建Swagger UI

在Linux上搭建Swagger UI可以帮助你为你的API提供一个交互式的文档界面。以下是一个基本的步骤指南，使用Docker来简化安装过程：

方法一：使用Docker

1. 安装Docker： 如果你还没有安装Docker，请先安装它。你可以使用以下命令来安装Docker：

   sudo apt update
   sudo apt install docker.io
   

2. 拉取Swagger UI Docker镜像： 使用以下命令来拉取Swagger UI的Docker镜像：

   docker pull swaggerapi/swagger-ui-express
   

3. 运行Swagger UI容器： 使用以下命令来运行Swagger UI容器。你需要将<your-swagger-json-url>替换为你的Swagger JSON文件的URL。

   docker run -p 80:80 -e SWAGGER_JSON="<your-swagger-json-url>" -d swaggerapi/swagger-ui-express
   

   这将启动一个容器，并将容器的80端口映射到主机的80端口。

4. 访问Swagger UI： 打开浏览器并访问http://localhost/swagger-ui.html，你应该能够看到你的API文档。

方法二：手动安装

如果你不想使用Docker，可以手动安装Swagger UI。以下是步骤：

1. 安装Node.js和npm： 如果你还没有安装Node.js和npm，请先安装它们。你可以使用以下命令来安装：

   sudo apt update
   sudo apt install nodejs npm
   

2. 创建项目目录： 创建一个新的项目目录并进入该目录：

   mkdir swagger-ui
   cd swagger-ui
   

3. 初始化npm项目： 初始化一个新的npm项目：

   npm init -y
   

4. 安装Swagger UI Express： 安装Swagger UI Express库：

   npm install swagger-ui-express
   

5. 创建服务器文件： 创建一个名为server.js的文件，并添加以下代码：

   const express = require('express');
   const swaggerUi = require('swagger-ui-express');
   const YAML = require('yamljs');
   
   // Load Swagger document
   const swaggerDocument = YAML.load('./swagger.yaml');
   
   const app = express();
   
   // Serve Swagger docs
   app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));
   
   const PORT = process.env.PORT || 3000;
   app.listen(PORT, () => {
     console.log(`Server is running on port ${PORT}`);
   });
   

6. 创建Swagger JSON文件： 创建一个名为swagger.yaml的文件，并添加你的API文档。例如：

   swagger: '2.0'
   info:
     title: Sample API
     description: A sample API to demonstrate Swagger UI
     version: '1.0.0'
   paths:
     /users:
       get:
         summary: List all users
         responses:
           '200':
             description: An array of users
             schema:
               type: array
               items:
                 $ref: '#/definitions/User'
   definitions:
     User:
       type: object
       properties:
         id:
           type: integer
         name:
           type: string
   

7. 启动服务器： 使用以下命令启动服务器：

   node server.js
   

8. 访问Swagger UI： 打开浏览器并访问http://localhost:3000/api-docs，你应该能够看到你的API文档。

这两种方法都可以帮助你在Linux上搭建Swagger UI。使用Docker的方法更为简单和快捷，而手动安装则提供了更多的灵活性和控制。