REST API
To enable the REST API you can use the following starter in your pom.xml
:
<dependency>
<groupId>org.camunda.bpm.springboot</groupId>
<artifactId>camunda-bpm-spring-boot-starter-rest</artifactId>
<version>7.22.0-cibseven</version>
</dependency>
Do not forget, that extra repository should be added to settings.xml
or to the POM file, since CIB seven is available yet only at artifacts.cibseven.de.
<repositories>
<repository>
<id>mvn-cibseven-public</id>
<name>CIB seven Public Repository</name>
<url>https://artifacts.cibseven.de/repository/public/</url>
</repository>
</repositories>
By default the application path is engine-rest
, so without any further configuration you can access the api at http://localhost:8080/engine-rest
.
Because we use jersey, one can use spring boot’s common application properties. For example, to change the application path, use
spring.jersey.application-path=myapplicationpath
To modify the configuration or register additional resources, one can provide a bean which extends from
org.camunda.bpm.spring.boot.starter.rest.CamundaJerseyResourceConfig
:
@Component
@ApplicationPath("/engine-rest")
public class JerseyConfig extends CamundaJerseyResourceConfig {
@Override
protected void registerAdditionalResources() {
register(...);
}
}