API documentation

HTTP API

To integrate a process engine in any language, application or system, go-bpmn provides an HTTP API. The API is described using OpenAPI standard in version 3.1.0.

Explore the API

see OpenAPI documentation as HTML version

The structured API description in form of a yaml file, can be downloaded from the go-bpmn release artifacts:

linux

curl -L -o go-bpmn-openapi.yaml https://github.com/gclaussn/go-bpmn/releases/download/v0.3.0/go-bpmn-openapi.yaml

windows

PowerShell

curl.exe -L -o go-bpmn-openapi.yaml https://github.com/gclaussn/go-bpmn/releases/download/v0.3.0/go-bpmn-openapi.yaml

Go API

For embedding a process engine or automating a process, in Go, visit the documentation of Go module github.com/gclaussn/go-bpmn@v0.3.0.