ApiFlow

Appearance

ApiFlow Engine - 进阶部署 ​

Version: 0.1.0.alpha

进阶部署 ​

推荐部署方式 - 将 ApiFlow 系统目录与工作流部署目录分开管理，便于独立升级和维护。

部署架构 ​

/opt/
├── apiFlow/                    # ApiFlow 系统安装目录
│   └── apiFlow-1.0.0/
│       ├── bin/
│       ├── lib/
│       └── plugins/
└── my-apiflow-deployment/      # 工作流部署目录
    ├── config/                 # 部署配置（独立于系统目录）
    ├── logs/                   # 应用日志
    ├── tmp/                    # 临时文件
    └── workflow-project/       # 工作流项目（版本控制）

优势：

  • ✅ ApiFlow 系统升级不影响工作流和配置
  • ✅ 工作流项目可独立进行 Git 版本管理
  • ✅ 多个部署实例共享同一套 ApiFlow 系统
  • ✅ 配置和日志分离，便于运维管理

步骤 1：安装 ApiFlow 到系统目录 ​

Unix/Linux/macOS ​

bash
# 解压到系统目录
sudo mkdir -p /opt/apiFlow
sudo unzip apiFlow-1.0.0.zip -d /opt/apiFlow
cd /opt/apiFlow/apiFlow-1.0.0

# 确保脚本可执行
chmod +x bin/api

Windows ​

powershell
# 解压到系统目录
Expand-Archive apiFlow-1.0.0.zip -DestinationPath C:\Program Files\apiFlow\

步骤 2：配置环境变量 ​

将 ApiFlow 的 bin 目录添加到系统 PATH，使 api 命令全局可用。

macOS/Linux - Bash ​

编辑 ~/.bashrc 或 ~/.bash_profile：

bash
# ApiFlow 环境变量
export APIFLOW_HOME=/opt/apiFlow/apiFlow-1.0.0
export PATH=$APIFLOW_HOME/bin:$PATH

使配置生效：

bash
source ~/.bashrc

macOS/Linux - Zsh ​

编辑 ~/.zshrc：

bash
# ApiFlow 环境变量
export APIFLOW_HOME=/opt/apiFlow/apiFlow-1.0.0
export PATH=$APIFLOW_HOME/bin:$PATH

使配置生效：

bash
source ~/.zshrc

Windows ​

方法 1：图形界面配置

  1. 右键"此电脑" → "属性" → "高级系统设置" → "环境变量"
  2. 在"系统变量"中找到 Path，点击"编辑"
  3. 添加新路径：C:\Program Files\apiFlow\apiFlow-1.0.0\bin
  4. 点击"确定"保存

方法 2：PowerShell 配置（管理员权限）

powershell
[Environment]::SetEnvironmentVariable(
    "Path",
    "$env:Path;C:\Program Files\apiFlow\apiFlow-1.0.0\bin",
    "Machine"
)

验证安装 ​

关闭并重新打开终端窗口，测试：

bash
api -v

应输出版本信息：

ApiFlow Engine version 1.0.0

步骤 3：创建部署目录 ​

选择一个部署位置，创建部署目录结构：

bash
# Unix/Linux/macOS
mkdir -p /opt/my-apiflow-deployment
cd /opt/my-apiflow-deployment

# Windows
mkdir C:\deployments\my-apiflow-deployment
cd C:\deployments\my-apiflow-deployment

创建必要的子目录：

bash
mkdir config logs tmp

步骤 4：准备工作流项目 ​

方式 1：从 Git 仓库克隆

bash
cd /opt/my-apiflow-deployment
git clone https://github.com/your-org/your-workflow-project.git workflow-project

方式 2：拷贝现有项目

bash
cp -r /path/to/existing-workflow workflow-project

步骤 5：配置部署环境 ​

从 ApiFlow 系统目录拷贝配置模板到部署目录：

bash
# Unix/Linux/macOS
cp /opt/apiFlow/apiFlow-1.0.0/config/application.properties config/
cp /opt/apiFlow/apiFlow-1.0.0/config/logback-spring.xml config/

# Windows
copy "C:\Program Files\apiFlow\apiFlow-1.0.0\config\application.properties" config\
copy "C:\Program Files\apiFlow\apiFlow-1.0.0\config\logback-spring.xml" config\

编辑 config/application.properties，修改关键配置：

properties
# 指向部署目录中的工作流项目（相对路径）
project.home=workflow-project

# 修改服务端口（如需要）
server.port=8824

# 固定管理端口（推荐，便于监控）
management.server.port=9090

# 其他配置保持默认或按需调整
async.corePoolSize=10
async.maximumPoolSize=50
cron.poolSize=5
webhook.path=/api
webhook.address=http://127.0.0.1:${server.port}/${webhook.path}

步骤 6：启动服务 ​

进入部署目录并启动：

bash
cd /opt/my-apiflow-deployment

# 前台启动（查看启动日志）
api start

# 后台启动（生产环境推荐）
api start -d

验证启动：

bash
# 检查服务状态
api status

# 测试工作流
curl http://127.0.0.1:8824/api/demo

多实例部署 ​

借助进阶部署模式，可轻松在同一服务器运行多个 ApiFlow 实例：

bash
# 实例 1：生产环境
/opt/production-apiflow/
├── config/application.properties  # server.port=8824
└── workflow-project/

# 实例 2：测试环境
/opt/staging-apiflow/
├── config/application.properties  # server.port=8825
└── workflow-project/

# 启动多个实例
cd /opt/production-apiflow && api start -d
cd /opt/staging-apiflow && api start -d

注意： 每个实例必须使用不同的端口号（server.port 和 management.server.port）。

下一步： 运维操作 - 学习日常运维命令、监控配置和故障排查