ApiFlow Studio 使用指南

简介

ApiFlow Studio 是ApiFlow的配套开发工具，提供工作流开发、调式、可视化 能力，可配合各AI编程工具使用。

系统要求

• Java: 需要 Java 11 或更高版本
• 操作系统: Windows、Linux、macOS

程序结构

下载ApiFlow Studio 程序，然后在指定位置解压，并进入解压后的程序目录

apiFlow-studio/
├── lib/                              # 应用程序 JAR 包目录
│   └── apiFlow-server-*.jar         # Spring Boot 主应用程序包
├── apiFlow-engine-0.1.0.Alpha/      # 独立引擎服务（用于生产部署）
│   ├── bin/                         # 引擎启动脚本
│   ├── config/                      # 引擎配置文件
│   ├── doc/                         # 引擎文档
│   ├── examples/                    # 示例工作流
│   ├── lib/                         # 引擎依赖库
│   └── plugins/                     # 引擎插件目录
├── projects/                        # 工作流项目存储目录
    ├── root/                        # 默认工作流项目
├── application.properties           # 主配置文件
├── start.sh                         # Linux/macOS 启动脚本
├── start.bat                        # Windows 启动脚本
└── README.md                        # 本文档

目录说明

lib 目录

包含 ApiFlow Studio 主应用程序 JAR 包，包括完整的 Web 服务和工作流开发环境。

projects/root 目录

默认工作流项目，建议在 application.properties 中的 project.home 指定其它目录，好与程序目录分开。

apiFlow-engine-0.1.0.Alpha 目录

独立的工作流引擎服务，用于生产环境独立部署 。主要特点：

• 轻量级：无 Web UI，仅提供工作流执行引擎
• 独立部署：可单独部署在生产服务器上运行工作流
• 高性能：专注于工作流执行，资源占用最小

快速启动

Windows 系统

双击运行 start.bat 或在命令提示符中执行：

start.bat

Linux / macOS 系统

在终端中执行：

./start.sh

或者：

bash start.sh

访问应用

启动成功后，在浏览器中打开：

http://localhost:8405

注意：默认端口为 8405，可以通过修改 application.properties 中的 server.port 来更改端口。

配置说明

application.properties 配置文件

主要配置项：

配置项	说明	默认值
project.home	项目工作空间目录，用于存储工作流项目文件	${user.dir}/projects/root
server.port	服务监听端口	8405
webhook.address	外部回调地址，用于接收工作流触发的 Webhook 请求	http://127.0.0.1:${server.port}/api

配置示例

# 工作流项目路径 
project.home=projects/root

# 服务端口
server.port=8080

# 外部 webhook 回调地址
webhook.address=http://your-domain.com:8080/api

提示:

• project.home 支持相对路径和绝对路径
• webhook.address 在生产环境中应配置为外部可访问的地址

JVM 参数配置

启动脚本配置了以下默认 JVM 参数：

• 内存配置:
  • 最大堆内存：256MB (-Xmx256m)
  • 初始堆内存：1024MB (-Xms1024m)
• 编码配置: UTF-8 (-Dfile.encoding=UTF-8)

如需调整，请编辑 start.sh 或 start.bat 中的 JVM_OPTS 变量。

常见问题

1. 启动失败：找不到 Java

解决方案:

• 安装 Java 11 或更高版本
• 确保 java 命令已添加到系统 PATH 环境变量中

2. 端口已被占用

解决方案:

• 修改 application.properties 中的 server.port 为其他可用端口
• 或关闭占用 8405 端口的其他程序

3. 无法访问 Webhook

解决方案:

• 检查防火墙设置，确保端口已开放
• 在 application.properties 中配置正确的 webhook.address

更多信息

• 官方文档: 查看项目 apiFlow-engine-{版本号}/doc 目录
• 示例工作流: 参考 apiFlow-engine-{版本号}/examples 目录
• 技术支持: 提交问题或联系开发团队

---

© 2024 ApiFlow Studio. 保留所有权利。