ubuntu

如何在Ubuntu上自定义Swagger UI

小樊
47
2025-04-07 07:52:02
栏目: 智能运维

在Ubuntu上自定义Swagger UI,您需要遵循以下步骤:

  1. 安装Swagger UI: 首先,确保您已经安装了Node.js和npm。然后,通过运行以下命令来全局安装Swagger UI:

    npm install -g swagger-ui-express
    
  2. 创建一个简单的Express应用: 在您的Ubuntu系统上创建一个新的文件夹,例如swagger-ui-customization,然后进入该文件夹。接下来,创建一个名为app.js的文件,并添加以下内容:

    const express = require('express');
    const swaggerUi = require('swagger-ui-express');
    const YAML = require('yamljs');
    
    const app = express();
    const port = process.env.PORT || 3000;
    
    // 读取Swagger JSON文件
    const swaggerDocument = YAML.load('./swagger.json');
    
    // 自定义Swagger UI选项
    const customUiOptions = {
      deepLinking: true,
      presets: [
        swaggerUi.presets.apis,
        swaggerUi.presets.promises,
      ],
      plugins: [
        swaggerUi.plugins.DownloadUrl,
      ],
      layout: "StandaloneLayout",
    };
    
    // 使用自定义选项启动Swagger UI
    app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument, customUiOptions));
    
    app.listen(port, () => {
      console.log(`Server is running at http://localhost:${port}`);
    });
    

    在这个例子中,我们使用了一个名为swagger.json的Swagger JSON文件。您需要将其替换为您自己的Swagger JSON文件。

  3. 安装依赖项: 在项目文件夹中运行以下命令来安装所需的依赖项:

    npm install express yamljs
    
  4. 运行应用: 在项目文件夹中运行以下命令来启动应用:

    node app.js
    

    现在,您可以在浏览器中访问http://localhost:3000/api-docs来查看自定义的Swagger UI。

  5. 自定义Swagger UI: 您可以通过修改customUiOptions对象来自定义Swagger UI。例如,您可以更改布局、添加插件或更改主题。有关可用选项的详细信息,请参阅swagger-ui-express文档

  6. 部署应用: 当您对自定义的Swagger UI满意时,可以将其部署到Ubuntu服务器上。您可以使用PM2、Docker或其他任何适合您需求的工具来部署应用。

0
看了该问题的人还看了