API 文档

流程引擎+表单引擎提供完整的 RESTful API 接口。

基础信息

接口地址

• 本地部署：http://localhost:8080/api/v1
• 公网服务：https://api.hzworkflow.com/v1

认证方式

Authorization: Bearer your_token

响应格式

{
  "success": true,
  "data": {},
  "message": "操作成功",
  "timestamp": "2024-01-15T10:30:00Z"
}

接口列表

表单接口

方法	路径	说明
GET	/forms	查询表单列表
GET	/forms/{id}	获取表单详情
POST	/forms	创建表单
PUT	/forms/{id}	更新表单
DELETE	/forms/{id}	删除表单
PUT	/forms/{id}/publish	发布表单

流程接口

方法	路径	说明
GET	/flows	查询流程列表
GET	/flows/{id}	获取流程详情
POST	/flows	创建流程
PUT	/flows/{id}	更新流程
DELETE	/flows/{id}	删除流程

数据接口

方法	路径	说明
GET	/data/{formId}	查询表单数据
GET	/data/{formId}/{dataId}	获取数据详情
POST	/data/{formId}	提交表单数据
PUT	/data/{formId}/{dataId}	更新表单数据
DELETE	/data/{formId}/{dataId}	删除表单数据

用户与组织接口

方法	路径	说明
GET	/users	查询用户列表
GET	/users/{id}	获取用户详情
POST	/users	创建用户
PUT	/users/{id}	更新用户
DELETE	/users/{id}	删除用户
GET	/departments	查询部门列表
POST	/departments	创建部门

错误代码

错误码	说明
40001	参数校验失败
40002	表单不存在
40101	未授权访问
40301	无权限操作
50001	系统内部错误