Camunda Engine OpenAPI REST Client Java and Spring Boot
This community extension is a convenience wrapper around the generated Java client from the Camunda Platform 7.x OpenAPI spec.
Example application
An example application using this community extension in a Spring Boot context can be found here: https://github.com/berndruecker/camunda-platform-remote-spring-boot-example
Using the client
Plain Java
In a plain Java project you can simply add this dependency:
<dependency>
<groupId>org.camunda.community</groupId>
<artifactId>camunda-engine-rest-client-openapi-java</artifactId>
<version>7.16.0-alpha1</version>
</dependency>
Now you can use the ApiClient and various generated artifacts, for example:
public static void main(String[] args) throws ApiException {
ApiClient client = new ApiClient("http://localhost:8080/engine-rest");
new DeploymentApi(client).createDeployment(
null,
null,
true,
true,
"benchmark",
null,
new File(App.class.getClassLoader().getResource(bpmnXmlPath).getFile())
);
System.out.println("DEPLOYED");
new ProcessDefinitionApi(client).startProcessInstanceByKey(
processId,
new StartProcessInstanceDto()
.variables(Collections.singletonMap("json", new VariableValueDto().value("test").type("string"))));
System.out.println("STARTED");
}
Spring Boot Starter
For convenience, there is also a Spring Boot Starter, that
- Wires the ApiClient and provide all API's
- Autodeploys all BPMN, DMN and form resources it finds on the classpath during startup.
Add this dependency:
<dependency>
<groupId>org.camunda.community</groupId>
<artifactId>camunda-engine-rest-client-openapi-springboot</artifactId>
<version>7.16.0-alpha1</version>
</dependency>
You can configure the Camunda endpoint via your application.properties:
camunda.bpm.client.base-url: http://localhost:8080/engine-rest
And then simply inject the API, for example:
@RestController
public class ExampleRestEndpoint {
@Autowired
private ProcessDefinitionApi processDefinitionApi;
@PutMapping("/start")
public ResponseEntity<String> startProcess(ServerWebExchange exchange) throws ApiException {
// ...
// start process instance
ProcessInstanceWithVariablesDto processInstance = processDefinitionApi.startProcessInstanceByKey(
ProcessConstants.PROCESS_KEY,
new StartProcessInstanceDto().variables(variables));
// ...
Spring Boot OpenAPI + External Task Bundle
Most often you might also want to use the OpenAPI, but also leverage the Camunda External Task Client as Spring Boot Starter. To do so you can simply add this convenience library which bundles both:
<dependency>
<groupId>org.camunda.community</groupId>
<artifactId>camunda-engine-rest-client-complete-springboot-starter</artifactId>
<version>7.16.0-SNAPSHOT</version>
</dependency>
Now you further simply add workers, for example:
@Configuration
@ExternalTaskSubscription("check-number")
public class ExampleCheckNumberWorker implements ExternalTaskHandler {
private final static Logger LOGGER = Logger.getLogger(ExampleCheckNumberWorker.class.getName());
@Override
public void execute(ExternalTask externalTask, ExternalTaskService externalTaskService) {
// ...
externalTaskService.complete(externalTask);
}
![[BUG] User Feign Client Naming Issue](https://avatars.githubusercontent.com/u/5864045?v=4)
14.8k Dec 30, 2022
19 Jun 6, 2022
4.5k Dec 30, 2022
24.8k Jan 6, 2023
11 Jul 16, 2022
5 Sep 30, 2021
4.7k Jan 3, 2023
37 Dec 26, 2022
7 Nov 29, 2022
46 Jan 3, 2023
58 Jan 5, 2023
3 Aug 29, 2022
3 Oct 2, 2021
10 Dec 15, 2022
9 Nov 23, 2022
16 Dec 13, 2022
3 Aug 11, 2022
1.1k Dec 15, 2022