#engine #send-request #client #requests #cli-tool #api-client #5minds

bin+lib processcube_engine_client

用 Rust 编写的 5Minds ProcessCube® Engine 客户端

6 个版本

0.3.0 2023 年 11 月 21 日
0.2.2 2023 年 11 月 21 日
0.1.1 2023 年 11 月 14 日

#9 in #send-request

每月 24 次下载

MIT 许可证

58KB
1K SLoC

ProcessCube.Engine.Client.rs

一个用 Rust 编写的库和 CLI 工具,用于向 5Minds ProcessCube® Engine API 发送请求。

该项目旨在与 Docker Image 中提供的 ProcessCube® Engine API 一起使用 5minds/processcube_engine:16.0.0

较旧或较新的版本 可能 也可以使用,但支持不能保证。

当前覆盖率

当前可用的端点覆盖率相当有限。

端点 CLI
匿名会话
应用程序信息
相关性
定时任务
数据对象实例
空活动
事件
外部任务
流程节点实例
手动任务
通知
流程定义
流程实例
流程模型
用户元数据
用户任务

✅ 完全支持 - ❌ 无支持 - GET/POST/... 部分支持

使用方法

CLI

如果您只想使用 processcube_engine_client CLI 工具,可以使用

cargo install processcube_engine_client

来安装它。然后您应该能够使用它,例如 processcube_engine_client application-info authority

在开发应用程序时,您可以通过将此包添加到您的项目来使用库

cargo add processcube_engine_client

简短的使用示例

use processcube_engine_client::clients::{client_factory::ClientFactory, error::EngineError};

// Be sure to have a running ProcessCube® Engine at the given URL
const ENGINE_URL: &str = "https://127.0.0.1:10560";
const DUMMY_TOKEN: &str = "Bearer ZHVtbXlfdG9rZW4=";

#[tokio::main]
async fn main() -> Result<(), EngineError> {
    let client_factory = ClientFactory::new(ENGINE_URL, DUMMY_TOKEN);
    let client = client_factory.create_application_info_client();
    let info = client.get_application_info().await?;
    println!("{:#?}", info);
    Ok(())
}

开发

先决条件

设置

  1. 克隆此存储库
  2. 运行 docker run -p 10560:80 5minds/processcube_engine:16..0.0 以启动 5Minds ProcessCube® Engine
  3. 准备就绪!

现在您可以通过运行 cargo test 来执行测试,或者通过 cargo run --bin processcube_engine_client 来运行 CLI 工具。API 的 Swagger 文档可以在 https://127.0.0.1:10560/ 找到。

依赖关系

约 7–19MB
约 287K SLoC