Debian如何自定義Swagger UI

在Debian系統上自定義Swagger UI，通常涉及以下幾個步驟：

1. 安裝Swagger UI： 如果你還沒有安裝Swagger UI，可以通過npm（Node.js的包管理器）來安裝。首先，確保你已經安裝了Node.js和npm。然后，運行以下命令來全局安裝Swagger UI：

   npm install -g swagger-ui-express
   

2. 創建一個Express應用： 創建一個新的Node.js項目，并在其中設置一個簡單的Express服務器。如果你還沒有創建項目，可以使用以下命令：

   mkdir my-swagger-ui-app
   cd my-swagger-ui-app
   npm init -y
   

   然后安裝Express：

   npm install express
   

3. 集成Swagger UI： 在你的Express應用中，使用swagger-ui-express來集成Swagger UI。創建一個名為app.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 at http://localhost:${PORT}`);
   });
   

   確保你有一個名為swagger.yaml的Swagger文檔文件在你的項目目錄中。

4. 自定義Swagger UI： swagger-ui-express允許你通過傳遞選項來自定義Swagger UI。例如，你可以更改UI的主題、深度、顯示操作ID等。在app.js中，你可以這樣自定義Swagger UI：

   const options = {
     deepLinking: true,
     presets: [
       swaggerUi.presets.apis,
       swaggerUi.presets.promises
     ],
     plugins: [
       swaggerUi.plugins.DownloadUrl
     ],
     layout: "StandaloneLayout"
   };
   
   app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument, options));
   

   你可以查看swagger-ui-express的GitHub頁面來了解更多可用的選項。

5. 運行你的應用： 在終端中運行你的應用：

   node app.js
   

   現在，你應該能夠在瀏覽器中訪問http://localhost:3000/api-docs來查看自定義的Swagger UI。

請注意，這些步驟假設你已經有了一個Swagger文檔（通常是YAML或JSON格式）。如果你還沒有Swagger文檔，你需要根據你的API定義一個。你可以使用Swagger Editor來創建和編輯Swagger文檔。