在Debian系統下進行Swagger版本管理，通常涉及以下幾個步驟：
安裝必要的軟件包：
確保你的Debian系統已經安裝了必要的軟件包，包括git和nodejs（如果你打算使用Swagger UI）。
sudo apt update
sudo apt install git nodejs npm
安裝Swagger工具：
使用swagger-jsdoc和swagger-ui-express來生成和托管Swagger文檔。
npm install swagger-jsdoc swagger-ui-express --save
創建Swagger配置文件：
在你的項目根目錄下創建一個swagger.json文件，用于定義你的API規范。
{
"swagger": "2.0",
"info": {
"version": "1.0.0",
"title": "My API",
"description": "A sample API"
},
"paths": {
"/api/v1/hello": {
"get": {
"summary": "Get a hello message",
"responses": {
"200": {
"description": "A successful response",
"schema": {
"type": "string"
}
}
}
}
}
}
}
創建Express應用并集成Swagger：
創建一個app.js文件，并集成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.get('/api/v1/hello', (req, res) => {
res.send('Hello World!');
});
const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
console.log(`Server is running on port ${PORT}`);
});
版本控制： 將你的項目推送到Git倉庫進行版本控制。
git init
git add .
git commit -m "Initial commit with Swagger setup"
git remote add origin <your-repository-url>
git push -u origin master
更新Swagger文檔：
每次更新API規范時，更新swagger.json文件并提交更改到Git倉庫。
git add swagger.json
git commit -m "Update API version to 1.1.0"
git push origin master
自動化部署（可選）： 使用CI/CD工具（如GitHub Actions）來自動化部署過程。以下是一個簡單的GitHub Actions工作流示例：
name: Deploy Swagger UI
on:
push:
branches:
- master
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Install dependencies
run: npm install
- name: Build and serve Swagger UI
run: node app.js
env:
PORT: ${{ github.workspace }}/3000
通過以上步驟，你可以在Debian系統上實現Swagger版本控制，并確保你的API文檔始終是最新的。
