Giter Club home page Giter Club logo

camunda-rest's Introduction

Spring Boot Web application with embedded Camunda engine

This example demonstrates how you can build a Spring Boot Web application with the following configured:

  • Embedded Camunda engine accessible via REST
  • Process application and one BPMN process deployed
  • Spring Boot Security basic authentication

It also contains a couple of integration tests, showing how this can be tested.

How is it done

  1. To embed the Camunda Engine accessible via REST API you must add following dependency to your pom.xml:
...
<dependency>
  <groupId>org.camunda.bpm.springboot</groupId>
  <artifactId>camunda-bpm-spring-boot-starter-rest</artifactId>
  <version>3.4.0</version>
</dependency>
...
  1. With Spring Boot you usually create an "application" class annotated with @SpringBootApplication. In order to have the Camunda process application registered, you can simply add an annotation @EnableProcessApplication to the same class and also include processes.xml file to your META-INF folder:
@SpringBootApplication
@EnableProcessApplication
public class RestApplication {

  public static void main(final String... args) throws Exception {
    SpringApplication.run(RestApplication.class, args);
  }

}
  1. You can also put BPMN, CMMN and DMN files in your classpath, they will be automatically deployed and registered within a process application.

Note: Basic authentication is configured on Spring Boot level, this is NOT a Camunda Engine authentication. Check this docs to configure Basic Authentication for Camunda Engine REST API.

Run the application and call the REST API

You can then build the application with mvn clean install and then run it with java -jar command.

Then you can access the REST API in the browser through: http://localhost:8080/rest/engine (provide login/password: user/password).

Another endpoint to test: http://localhost:8080/rest/engine/default/process-definition - this will show you the deployed process definition.

camunda-rest's People

Contributors

hlucasfranca avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.