Debian上Swagger如何進行版本控制

在Debian系統上進行Swagger的版本控制，可以遵循以下步驟：

1. 安裝Swagger工具

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

sudo apt update
sudo apt install nodejs npm
sudo npm install -g swagger-jsdoc swagger-ui-express

2. 初始化項目

創建一個新的Node.js項目，并初始化它。

mkdir my-swagger-project
cd my-swagger-project
npm init -y

3. 創建Swagger配置文件

在你的項目根目錄下創建一個swagger.json文件，用于定義你的API規范。

{
  "swagger": "2.0",
  "info": {
    "description": "Sample API",
    "version": "1.0.0"
  },
  "host": "api.example.com",
  "basePath": "/v1",
  "paths": {
    "/users": {
      "get": {
        "summary": "List all users",
        "responses": {
          "200": {
            "description": "A list of users"
          }
        }
      }
    }
  }
}

4. 使用Swagger UI Express

在你的項目中創建一個app.js文件，并使用Swagger UI Express來展示你的API文檔。

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));

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

5. 版本控制

使用Git進行版本控制。

git init
git add .
git commit -m "Initial commit with Swagger setup"

6. 更新Swagger規范

當你更新API規范時，修改swagger.json文件并提交更改。

# 修改swagger.json文件
vim swagger.json

# 提交更改
git add swagger.json
git commit -m "Update API version to 1.0.1"

7. 部署

你可以將你的應用部署到Debian服務器上。使用PM2來管理你的Node.js應用。

sudo npm install -g pm2
pm2 start app.js --name my-swagger-app

8. 自動化部署（可選）

你可以設置CI/CD管道來自動化部署過程。例如，使用GitHub Actions。

在項目根目錄下創建.github/workflows/deploy.yml文件：

name: Deploy to Debian

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout code
      uses: actions/checkout@v2

    - name: Set up Node.js
      uses: actions/setup-node@v2
      with:
        node-version: '14'

    - name: Install dependencies
      run: npm install

    - name: Build and deploy
      run: |
        npm run build
        pm2 deploy ecosystem.config.js --env production

在項目根目錄下創建ecosystem.config.js文件：

module.exports = {
  apps: [{
    name: 'my-swagger-app',
    script: 'app.js',
    instances: 'max',
    exec_mode: 'cluster',
    env: {
      NODE_ENV: 'production'
    },
    env_production: {
      NODE_ENV: 'production'
    }
  }]
};

通過以上步驟，你可以在Debian系統上進行Swagger的版本控制，并且可以方便地部署和更新你的API文檔。