Debian系統中Swagger版本管理技巧

在Debian系統中使用Swagger（現通常指的是OpenAPI Specification）進行API文檔版本管理，可以通過以下幾個步驟來完成：

安裝Swagger工具

首先，你需要安裝Swagger工具，比如 swagger-ui-express，這是一個用于Express應用程序的Swagger UI中間件。你可以使用npm來安裝它：

npm install swagger-ui-express

創建API規范文件

使用OpenAPI Specification（OAS）定義你的API。你可以手動編寫YAML或JSON格式的規范文件，或者使用Swagger Editor在線工具來創建和編輯規范。

example-v1.yaml:

openapi: 3.0.0
info:
  title: Sample API
  version: 1.0.0
paths:
  /items:
    get:
      summary: List all items (v1)
      responses:
        '200':
          description: An array of items

example-v2.yaml:

openapi: 3.0.0
info:
  title: Sample API
  version: 2.0.0
paths:
  /items:
    get:
      summary: List all items (v2)
      responses:
        '200':
          description: An array of items with more details

集成Swagger UI

在你的Express應用程序中集成Swagger UI，并指向你的API規范文件。

const express = require('express');
const swaggerUi = require('swagger-ui-express');
const YAML = require('yamljs');
const app = express();

const swaggerDocumentV1 = YAML.load('./example-v1.yaml');
const swaggerDocumentV2 = YAML.load('./example-v2.yaml');

app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocumentV1));
app.use('/api-docs/v2', swaggerUi.serve, swaggerUi.setup(swaggerDocumentV2));

const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
  console.log(`Server is running on port ${PORT}`);
});

版本管理

為了實現API文檔的版本管理，你可以在規范文件中為每個版本創建不同的路徑或標簽。然后，你可以根據請求的URL路徑或HTTP頭中的自定義標簽來提供不同版本的API文檔。

部署和測試

部署你的應用程序，并通過瀏覽器訪問不同的版本路徑來測試API文檔是否正確顯示。

# 啟動應用程序
node app.js

訪問以下URL來測試不同版本的API文檔：

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

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