Debian Swagger如何實現API版本管理

在Debian系統中實現Swagger API版本管理，可以遵循以下步驟：

1. 安裝Swagger工具

首先，確保你的Debian系統上已經安裝了Swagger工具。你可以使用以下命令來安裝Swagger：

sudo apt update
sudo apt install swagger-ui-express

2. 創建API版本控制目錄結構

為了管理不同版本的API，你可以創建一個目錄結構來組織你的API文件。例如：

/api
    /v1
        /controllers
            userController.js
        /routes
            userRoutes.js
    /v2
        /controllers
            userControllerV2.js
        /routes
            userRoutesV2.js

3. 配置Swagger

在每個版本的API目錄中創建一個Swagger配置文件（例如swagger.json），并定義該版本的API規范。

v1/swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "User API",
    "version": "1.0.0"
  },
  "paths": {
    "/users": {
      "get": {
        "summary": "Get all users",
        "responses": {
          "200": {
            "description": "A list of users"
          }
        }
      }
    }
  }
}

v2/swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "User API",
    "version": "2.0.0"
  },
  "paths": {
    "/users": {
      "get": {
        "summary": "Get all users with additional details",
        "responses": {
          "200": {
            "description": "A list of users with additional details"
          }
        }
      }
    }
  }
}

4. 配置Express應用

在你的Express應用中，根據請求的版本號來加載相應的Swagger配置和路由。

const express = require('express');
const swaggerUi = require('swagger-ui-express');
const swaggerDocumentV1 = require('./api/v1/swagger.json');
const swaggerDocumentV2 = require('./api/v2/swagger.json');

const app = express();
const port = 3000;

// Middleware to determine API version
app.use('/api-docs', (req, res, next) => {
  const version = req.query.version || 'v1'; // Default to v1 if no version is specified
  switch (version) {
    case 'v2':
      res.setHeader('Content-Type', 'application/json');
      res.send(swaggerDocumentV2);
      break;
    default:
      res.setHeader('Content-Type', 'application/json');
      res.send(swaggerDocumentV1);
      break;
  }
});

// Serve Swagger UI for v1
app.use('/api-docs/v1', swaggerUi.serve, swaggerUi.setup(swaggerDocumentV1));

// Serve Swagger UI for v2
app.use('/api-docs/v2', swaggerUi.serve, swaggerUi.setup(swaggerDocumentV2));

// Start the server
app.listen(port, () => {
  console.log(`Server is running on http://localhost:${port}`);
});

5. 測試API版本管理

現在，你可以通過訪問不同的URL來測試不同版本的API文檔：

• http://localhost:3000/api-docs 默認顯示v1版本的API文檔
• http://localhost:3000/api-docs?version=v2 顯示v2版本的API文檔

通過這種方式，你可以在Debian系統上實現Swagger API版本管理，并且可以輕松地添加新的API版本。