如何在CentOS上使用Swagger Editor

在CentOS上使用Swagger Editor的步驟

1. 安裝Node.js和npm

Swagger Editor依賴Node.js環境，需先安裝Node.js（包含npm包管理器）。

方法一：通過NodeSource倉庫安裝（推薦）
運行以下命令添加NodeSource倉庫并安裝Node.js（以Node.js 14.x為例）：
```
curl -sL https://rpm.nodesource.com/setup_14.x | sudo -E bash -
sudo yum install -y nodejs
```
驗證安裝：
安裝完成后，執行以下命令確認版本（需顯示版本號即為成功）：
```
node -v  # 查看Node.js版本
npm -v   # 查看npm版本
```

2. 安裝Swagger Editor

有兩種常見方式安裝Swagger Editor：

方式一：全局安裝（快速啟動）
使用npm全局安裝Swagger Editor及其依賴的HTTP服務器：
```
sudo npm install -g swagger-editor http-server
```

方式二：從源碼安裝（自定義配置）
若需要修改Editor源碼，可克隆官方倉庫并本地安裝：

git clone https://github.com/swagger-api/swagger-editor.git
cd swagger-editor
npm install -g http-server  # 安裝HTTP服務器

3. 啟動Swagger Editor

全局安裝的啟動方式：
直接運行以下命令啟動Editor服務，默認監聽8080端口：
```
swagger-editor
```
源碼安裝的啟動方式：
進入項目目錄，使用HTTP服務器啟動：
```
cd /path/to/swagger-editor
http-server -p 8080  # 指定端口（如8080）
```
訪問Editor：
啟動后，在瀏覽器中輸入http://localhost:8080（若為遠程服務器，替換為IP地址），即可打開Swagger Editor界面。

4. 使用Swagger Editor編寫/編輯文檔

新建文檔：
點擊界面左側的“+”號，選擇“Create New”創建空白文檔，或通過“Import File”上傳現有Swagger JSON/YAML文件。
編輯文檔：
在右側編輯區編寫API定義（支持YAML或JSON格式），左側實時預覽生成的文檔結構。
保存文檔：
編輯完成后，點擊頂部菜單欄的“File”→“Save As”，將文檔保存為swagger.json或swagger.yaml格式。

5. （可選）配置Swagger UI查看自定義文檔

若需將Swagger Editor編寫的文檔導入Swagger UI進行可視化展示，需完成以下步驟：

安裝Swagger UI：
克隆官方倉庫并安裝依賴：

git clone https://github.com/swagger-api/swagger-ui.git
cd swagger-ui
npm install

配置自定義文檔路徑：
進入Swagger UI的dist目錄，修改index.html文件，將默認的Swagger Petstore文檔URL替換為自己的文檔路徑（如/static/your-swagger.json）：
```
// 修改前（默認Petstore文檔）
url: "https://petstore.swagger.io/v2/swagger.json",
// 修改后（指向本地自定義文檔）
url: "/static/your-swagger.json",
```

啟動Swagger UI：
創建靜態文件目錄并復制文檔，啟動HTTP服務器：

mkdir -p /opt/swagger/public
cp -r swagger-ui/dist/* /opt/swagger/public/
cp /path/to/your-swagger.json /opt/swagger/public/
cd /opt/swagger/public
http-server -p 3000

訪問Swagger UI：
在瀏覽器中輸入http://localhost:3000，即可查看自定義的API文檔。

注意事項

防火墻設置：若為遠程訪問，需開放對應端口（如8080、3000），執行以下命令：
```
sudo firewall-cmd --permanent --add-port=8080/tcp
sudo firewall-cmd --reload
```
版本兼容性：建議使用Node.js 12.x及以上版本，避免依賴沖突。
權限問題：全局安裝時使用sudo，本地安裝無需sudo（推薦）。