ApiFlow

Appearance

ApiFlow Engine - 快速部署 ​

Version: 0.1.0.alpha

快速体验 ​

本节帮助您在 5 分钟内快速体验 ApiFlow 引擎的基本功能，无需任何配置即可启动并运行示例工作流。

1. 解压文件 ​

下载引擎发布包后，解压到任意目录：

bash
# Unix/Linux/macOS
unzip apiFlow-1.0.0.zip
cd apiFlow-1.0.0

# Windows PowerShell
Expand-Archive apiFlow-1.0.0.zip
cd apiFlow-1.0.0

目录结构说明：

apiFlow-1.0.0/
├── bin/                        # 可执行脚本
│   ├── api                     # Unix/Linux/macOS 启动脚本
│   └── api.cmd                 # Windows 启动脚本
├── lib/                        # 运行时 JAR 包
│   └── apiFlow-server-1.0.0.jar
├── config/                     # 配置文件目录
│   ├── application.properties  # 主配置文件
│   └── logback-spring.xml      # 日志配置文件
├── plugins/                    # 插件扩展目录
└── examples/                   # 示例工作流项目
    └── base_example/           # 基础示例项目（默认启动项目）
        ├── api/                # 工作流脚本目录
        │   └── welcome.groovy  # 欢迎示例工作流
        └── config.groovy       # 项目配置文件

2. 启动服务 ​

打开控制台窗口，进入解压后的目录，执行启动命令：

bash
# Unix/Linux/macOS
cd /path/to/apiFlow-1.0.0
./bin/api start

# Windows (需在 cmd 或 PowerShell 中执行)
cd C:\path\to\apiFlow-1.0.0
bin\api.cmd start

启动成功后，您会看到类似如下输出：

ApiFlow Engine is starting...
Server started successfully on port 8824

注意： 快速体验模式将自动启动内置的 examples/base_example 示例项目。

3. 访问工作流 ​

在浏览器中访问以下地址，体验欢迎工作流：

http://127.0.0.1:8824/api/welcome

您将看到返回的欢迎消息：

欢迎使用ApiFlow

4. 修改工作流并热重载 ​

现在尝试修改工作流并实时生效：

步骤 1：修改工作流文件

使用文本编辑器打开 examples/base_example/api/welcome.groovy，修改欢迎语：

groovy
// 访问 http://127.0.0.1:8824/api/welcome
init {
    listen webhook on "/welcome"
}

// 定义任务
欢迎任务 = CODE {
    "欢迎使用ApiFlow - 您已成功修改工作流！"
}

//编排任务
start {
    run 欢迎任务
}

保存文件。

步骤 2：热重载引擎

无需重启服务，执行重载命令：

bash
# Unix/Linux/macOS
./bin/api reload

# Windows
bin\api.cmd reload

您会看到类似输出：

Workflow reloaded successfully

步骤 3：观察变化

再次访问 http://127.0.0.1:8824/api/welcome，查看更新后的欢迎语。

常见问题排查 ​

如果快速体验过程中遇到问题，请检查以下几点：

1. Java 版本检查 ​

ApiFlow 需要 Java 11 或更高版本：

bash
java -version

确认输出中显示版本号 >= 11，例如：

java version "11.0.12" 2021-07-20 LTS

解决方案： 如果版本过低，请访问 Oracle JDK 或 OpenJDK 下载并安装 Java 11+。

2. curl 工具检查 ​

ApiFlow 的运维命令（如 reload、status）依赖 curl 工具：

bash
curl --version

解决方案：

  • macOS/Linux： 通常已预装，如未安装可通过包管理器安装（brew install curl / apt install curl）
  • Windows： Windows 10 1803+ 已内置 curl，旧版本需手动安装

3. 端口冲突检查 ​

默认端口 8824 可能被其他程序占用：

bash
# Unix/Linux/macOS
lsof -i :8824

# Windows PowerShell
netstat -ano | findstr :8824

解决方案： 修改 config/application.properties 文件中的端口号：

properties
server.port=8825

然后访问新端口：http://127.0.0.1:8825/api/welcome

4. 启动失败排查 ​

查看日志文件排查问题：

bash
# 查看最新日志
tail -f logs/apiflow.log

# 查看启动日志（如果使用了 -d 后台模式）
tail -f logs/startup.log

5. 防火墙问题 ​

确保本地防火墙允许访问 8824 端口，或临时关闭防火墙测试。

下一步： 基础配置 - 学习如何自定义配置和创建自己的工作流项目