rust-viewflow 0.1.0

Rust workflow library inspired by Viewflow, compatible with Axum and Actix-web
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

# Usage Guide

## Prerequisites

- Rust stable toolchain
- Cargo
- Optional: SQLite/MySQL/PostgreSQL

## 1) Build and test

```bash
cargo check --all-features --examples
cargo test --all-features
```

## 2) Run sample service (Axum)

```bash
cargo run --example leave_request
```

Service endpoint: `http://127.0.0.1:3000`

## 3) Create a leave workflow

```bash
curl -X POST http://127.0.0.1:3000/workflows \
  -H "Content-Type: application/json" \
  -d '{
    "workflow_type": "leave_request",
    "data": {
      "employee_id": "emp-001",
      "manager_id": "mgr-001",
      "hr_id": "hr-001",
      "start_date": "2026-03-01",
      "end_date": "2026-03-03",
      "reason": "annual leave",
      "locale": "en"
    }
  }'
```

## 4) Query workflow and tasks

```bash
curl http://127.0.0.1:3000/workflows/{workflow_id}
curl http://127.0.0.1:3000/workflows/{workflow_id}/tasks
```

## 5) Complete a task

```bash
curl -X POST http://127.0.0.1:3000/tasks/{task_id}/complete \
  -H "Content-Type: application/json" \
  -d '{"data": {"approved": true, "locale": "en"}}'
```

## 6) Actix example

```bash
cargo run --example leave_request_actix --features actix
```

Service endpoint: `http://127.0.0.1:3001`

## 7) Database backends

- SQLite: easiest local startup
- PostgreSQL/MySQL: production deployment
- Memory backend: tests and lightweight runtime

## 8) API summary

- `POST /workflows`
- `GET /workflows/{id}`
- `GET /workflows/{id}/tasks`
- `POST /tasks/{id}/complete`

## License

MIT