Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/korthout/camunda-platform-rest-api

A REST API for Camunda Platform 8
https://github.com/korthout/camunda-platform-rest-api

camunda camunda-platform-8 openapi rest rest-api restapi

Last synced: about 1 month ago
JSON representation

A REST API for Camunda Platform 8

Host: GitHub
URL: https://github.com/korthout/camunda-platform-rest-api
Owner: korthout
License: apache-2.0
Created: 2022-10-10T22:06:19.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-02-28T10:13:11.000Z (9 months ago)
Last Synced: 2024-04-14T15:02:14.544Z (7 months ago)
Topics: camunda, camunda-platform-8, openapi, rest, rest-api, restapi
Language: Kotlin
Homepage: https://korthout.github.io/camunda-platform-rest-api/
Size: 5.27 MB
Stars: 25
Watchers: 5
Forks: 3
Open Issues: 26
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        


  
Camunda Platform REST API




  

  


  

  

  



> [!WARNING]

> **This project is unmaintained** - There are ongoing efforts to add a REST API to Zeebe and ideas about unifying the REST APIs of all Camunda Platform 8 components.

> With that, it's time to sunset this project.

>

> Working on this project has taught me much about Spring and Kotlin and even more about REST APIs.

> I'm proud that Camunda is taking a path that was explored by this project and took note of our successes and mistakes to make a better product.

>

> Thank you all for all your feedback and support.

> Happy RESTful orchestrating!

## Introduction

Camunda Platform REST API is a REST API to interact with [Camunda Platform 8](https://camunda.com/platform/).

Camunda Platform 8 has multiple different APIs.

Typically, one for each component.

There are gRPC, GraphQL, and REST APIs for you to connect to and learn, which can be difficult and time consuming.

Camunda Platform REST API offers a single consistent REST API to interact with Camunda Platform 8.

- Get Started Quickly

> Camunda Platform REST API was designed to be easily installed, to get you connected to [Camunda Platform 8](https://camunda.com/platform/) quickly.

- Easy to Use

> Thanks to a consistent API design and an [OpenAPI](https://www.openapis.org/) specification, you can focus on interacting with Camunda Platform 8.

- Community Driven

> This project is community maintained. We welcome [contributions](https://github.com/korthout/camunda-platform-rest-api/blob/main/CONTRIBUTING.md) for feature requests and bug reports, as well as for docs and code changes.

### API

| Method  |          Resource          |                Description                 |

|---------|----------------------------|--------------------------------------------|

| `GET`   | `/status`                  | Retrieve the Topology of a Zeebe cluster   |

| `POST`  | `/process-instances`       | Create a new Process Instance              |

| `GET`   | `/process-instances/{key}` | Retrieve the details of a Process Instance |

| `GET`   | `/jobs`                    | Activate Jobs                              |

| `PATCH` | `/jobs/{key}`              | Update a Job                               |

| ..      | ..                         | Not yet implemented                        |

You can find the full API reference documentation in the [`openapi.yaml`](openapi.yaml) specification, and in the [Docs](https://korthout.github.io/camunda-platform-rest-api/).

## Getting Started

The easiest way to start the Camunda Platform REST API is using Docker.

```shell

docker pull ghcr.io/korthout/camunda-platform-rest-api:latest

```

Using the provided [Docker Compose file](./docker/docker-compose.yml) you can start a new local Camunda Platform 8 cluster and connect the Camunda Platform REST API to it.

This is a great way to try out the Camunda Platform REST API before connecting it to your production cluster.

```shell

docker compose -f ./docker/docker-compose.yml up -d

```

Once running, you can try it out the REST API.

```shell

curl localhost:8080/status

```

Or, explore the API in Swagger UI running at [/swagger-ui](http://localhost:8080/swagger-ui.html).

## Documentation

Read the [docs](https://korthout.github.io/camunda-platform-rest-api/) for any further information:

- [Connect to a cluster](https://korthout.github.io/camunda-platform-rest-api/docs/guides/connection)

- [Configuration](https://korthout.github.io/camunda-platform-rest-api/docs/guides/config)

- [API](https://korthout.github.io/camunda-platform-rest-api/docs/api)

## Acknowledgements

This software would not be possible without these awesome projects:

- [Spring Zeebe](https://github.com/camunda-community-hub/spring-zeebe)

  \- Easily use the Zeebe Java Client in your Spring or Spring Boot projects

- [Camunda Operate Client](https://github.com/camunda-community-hub/camunda-operate-client-java)

  \- Simplified Java client for the Operate API of Camunda Platform 8

- [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator)

  \- Generate clients, servers, and documentation from OpenAPI 2.0/3.x documents

- [Docusaurus OpenAPI Doc Generator](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs)

  \- OpenAPI plugin for generating API reference docs in Docusaurus v2.

- [kotlin-duration-string](https://github.com/blueanvil/kotlin-duration-string)

  \- A tiny Kotlin library for dealing with human-readable duration strings like `2h 45m 50s`

A full list of projects we depend on can be found in the [pom file](pom.xml).

## License

Camunda Platform REST API is Open Source software released under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0.html).