Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/northpowered/temporal-rest-executor
Small REST with Swagger UI server to work with Temporal objects
https://github.com/northpowered/temporal-rest-executor
fastapi python temporal workflow
Last synced: 2 months ago
JSON representation
Small REST with Swagger UI server to work with Temporal objects
- Host: GitHub
- URL: https://github.com/northpowered/temporal-rest-executor
- Owner: northpowered
- Created: 2023-04-04T13:53:36.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-28T18:26:58.000Z (over 1 year ago)
- Last Synced: 2024-08-02T11:14:00.548Z (5 months ago)
- Topics: fastapi, python, temporal, workflow
- Language: Python
- Homepage: https://northpowered.github.io/temporal-rest-executor/
- Size: 658 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-temporal - `northpowered/temporal-rest-executor` - Simple REST server (with Swagger UI) to execute any activity/workflow in Temporal namespace. Useful for development and I&T. (Tools)
README
# Temporal-REST-executor
[](https://codecov.io/github/northpowered/temporal-rest-executor)
[](https://github.com/northpowered/temporal-rest-executor/actions/workflows/ci.yml)
[](https://github.com/northpowered/temporal-rest-executor/actions/workflows/docker-image.yml)
[](https://sonarcloud.io/summary/new_code?id=northpowered_temporal-rest-executor)
This is a simple tool to execute [Temporal](https://temporal.io/) workflows/activities through the REST endpoints
All documentation are available [here](https://northpowered.github.io/temporal-rest-executor/)
Based on [FastAPI](https://github.com/tiangolo/fastapi) and may be useful for development and QA
## Quick start
Just run docker image
```bash
docker run -p 8000:8000 ghcr.io/northpowered/temporal-rest-executor:latest
```
You can add Temporal endpoint as an env var
```bash
docker run -e TEMPORAL_ENDPOINT=temporal:7233 -p 8000:8000 ghcr.io/northpowered/temporal-rest-executor:latest
```
And specify docker network (this is the example for default Temporal compose manifest)
```bash
docker run -e TEMPORAL_ENDPOINT=temporal:7233 -p 8000:8000 --network temporal-network ghcr.io/northpowered/temporal-rest-executor:latest
```
### Args for endpoints:
**Activity execution**
```
activity_name - [string] - REQUIRED
activity_task_queue - [string] - REQUIRED
args - [ANY] - may be null
start_to_close_timeout - [int] - Default is 10
schedule_to_start_timeout - [int] - may be null
heartbeat_timeout - [int] - may be null
schedule_to_close_timeout - [int] - may be null
retry_policy - [Object] - may be null
parent_workflow_id - [string] - If null, UUID4 will be used
parent_workflow_execution_timeout - [int] - Default is 10
parent_workflow_run_timeout - [int] - may be null
parent_workflow_task_timeout - [int] - may be null
# RetryPolicy object
initial_interval - [int] - Default is 1
backoff_coefficient - [float] - Default is 2
maximum_interval - [int] - may be null
maximum_attempts - [int] - Default is 0
```
**Workflow execution**
```
workflow_name - [string] - REQUIRED
workflow_task_queue - [string] - REQUIRED
args - [ANY] - may be null
execution_timeout - [int] - Default is 10
workflow_id- [string] - If null, UUID4 will be used
```
## Config
Some env vars:
**TEMPORAL_ENDPOINT = localhost:7233**
**TEMPORAL_NAMESPACE = default**
**TEMPORAL_INTERNAL_FLOW_NAME = InternalExecutionWorkflow**
**TEMPORAL_INTERNAL_TASK_QUEUE = internal-execution-queue**
**UVICORN_BIND_ADDR = 0.0.0.0**
**UVICORN_BIND_PORT = 8000**
**TELEMETRY_ENABLED = True**
**TELEMETRY_AGENT_HOST = localhost**
**TELEMETRY_AGENT_PORT = 6831**
**PROMETHEUS_ENDPOINT_ENABLED = True**
**PROMETHEUS_ENDPOINT_PORT = 9000**
## Usage
Default FastAPI Swagger is available
or You can use curl:
> Activity execution
```bash
curl -X 'POST' \
'http://localhost:8000/v1/activity/execute' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"activity_name": "your_remote_activity",
"activity_task_queue": "your_queue",
"args": "some args: string, object or null",
"start_to_close_timeout": 10,
"parent_workflow_id": "MyId",
"schedule_to_start_timeout": 0,
"heartbeat_timeout": 0,
"schedule_to_close_timeout": 0,
"retry_policy": {
"initial_interval": 1,
"backoff_coefficient": 2,
"maximum_interval": 0,
"maximum_attempts": 0
},
"parent_workflow_execution_timeout": 10,
"parent_workflow_run_timeout": 0,
"parent_workflow_task_timeout": 0
}'
```
> Workflow execution
```bash
curl -X 'POST' \
'http://localhost:8000/v1/workflow/execute' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"workflow_name": "string",
"workflow_task_queue": "string",
"args": "string",
"workflow_id": "string",
"execution_timeout": 1
}'
```