Linux系統中Swagger如何進行API版本管理

在Linux系統中，使用Swagger進行API版本管理可以通過以下步驟實現：

1. 安裝Swagger

首先，確保你的Linux系統上已經安裝了Swagger。你可以使用npm（Node.js的包管理器）來安裝Swagger。

sudo npm install -g swagger-jsdoc swagger-ui-express

2. 創建Swagger配置文件

在你的項目根目錄下創建一個名為swagger.json的文件，用于定義API的規范和版本信息。

{
  "swagger": "2.0",
  "info": {
    "title": "My API",
    "description": "API documentation for My API",
    "version": "1.0.0"
  },
  "host": "api.example.com",
  "basePath": "/v1",
  "schemes": [
    "http"
  ],
  "paths": {
    "/users": {
      "get": {
        "summary": "Get a list of users",
        "responses": {
          "200": {
            "description": "A JSON array of users"
          }
        }
      }
    }
  }
}

3. 在Express應用中使用Swagger

在你的Express應用中引入Swagger，并使用swagger-ui-express中間件來提供Swagger UI界面。

const express = require('express');
const swaggerUi = require('swagger-ui-express');
const swaggerDocument = require('./swagger.json');

const app = express();

app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));

app.listen(3000, () => {
  console.log('Server is running on port 3000');
});

4. 管理多個API版本

如果你有多個版本的API，可以在swagger.json文件中使用不同的basePath來區分它們。

版本1

{
  "swagger": "2.0",
  "info": {
    "title": "My API",
    "description": "API documentation for My API",
    "version": "1.0.0"
  },
  "host": "api.example.com",
  "basePath": "/v1",
  "schemes": [
    "http"
  ],
  "paths": {
    "/users": {
      "get": {
        "summary": "Get a list of users",
        "responses": {
          "200": {
            "description": "A JSON array of users"
          }
        }
      }
    }
  }
}

版本2

{
  "swagger": "2.0",
  "info": {
    "title": "My API",
    "description": "API documentation for My API",
    "version": "2.0.0"
  },
  "host": "api.example.com",
  "basePath": "/v2",
  "schemes": [
    "http"
  ],
  "paths": {
    "/users": {
      "get": {
        "summary": "Get a list of users (version 2)",
        "responses": {
          "200": {
            "description": "A JSON array of users (version 2)"
          }
        }
      }
    }
  }
}

5. 啟動應用

啟動你的Express應用，訪問http://localhost:3000/api-docs，你應該能夠看到Swagger UI界面，并且可以根據不同的版本查看相應的API文檔。

node app.js

總結

通過以上步驟，你可以在Linux系統中使用Swagger進行API版本管理。每個版本的API都有自己的basePath，并且在Swagger UI界面中可以清晰地看到不同版本的API文檔。這樣可以方便地進行API的維護和升級。