如何在Debian上部署Swagger API

在Debian上部署Swagger API，可以按照以下步驟進行：

1. 安裝必要的軟件

首先，確保你的Debian系統是最新的，并且安裝了必要的軟件包。

sudo apt update
sudo apt upgrade -y
sudo apt install -y nodejs npm git

2. 安裝Swagger UI

Swagger UI是一個用于展示和測試API的工具。你可以使用npm來安裝它。

sudo npm install -g swagger-ui-express

3. 創建一個簡單的Express應用

創建一個新的目錄來存放你的項目，并進入該目錄。

mkdir swagger-api
cd swagger-api

初始化一個新的Node.js項目。

npm init -y

安裝Express框架。

npm install express

4. 創建Swagger文檔

在你的項目目錄中創建一個名為swagger.json的文件，并添加你的API文檔。以下是一個簡單的示例：

{
  "swagger": "2.0",
  "info": {
    "description": "Sample API",
    "version": "1.0.0"
  },
  "host": "localhost:3000",
  "basePath": "/api",
  "schemes": [
    "http"
  ],
  "paths": {
    "/users": {
      "get": {
        "summary": "Get a list of users",
        "responses": {
          "200": {
            "description": "A JSON array of users",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/User"
              }
            }
          }
        }
      }
    }
  },
  "definitions": {
    "User": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      }
    }
  }
}

5. 創建Express應用并集成Swagger UI

在你的項目目錄中創建一個名為app.js的文件，并添加以下代碼：

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

const app = express();
const swaggerDocument = YAML.load('./swagger.json');

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

app.get('/api/users', (req, res) => {
  res.json([
    { id: 1, name: 'John Doe' },
    { id: 2, name: 'Jane Doe' }
  ]);
});

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

6. 運行你的應用

現在你可以運行你的Express應用了。

node app.js

打開瀏覽器并訪問http://localhost:3000/api-docs，你應該能夠看到Swagger UI界面，并且可以測試你的API。

7. 部署到生產環境

如果你打算將你的應用部署到生產環境，可以考慮使用PM2來管理你的Node.js進程。

安裝PM2：

sudo npm install -g pm2

使用PM2啟動你的應用：

pm2 start app.js --name swagger-api

你可以使用以下命令來查看應用的日志和狀態：

pm2 logs swagger-api
pm2 status

這樣，你就成功地在Debian上部署了一個Swagger API。