Skip to content
Swagger Support for Camunda BPM REST API
Java Other
  1. Java 99.5%
  2. Other 0.5%
Branch: master
Clone or download
Latest commit ce22010 Oct 17, 2018

README.md

Camunda BPM Swagger

Travis CI

Swagger Support for Camunda BPM REST API.

Features:

  • Provides a Swagger OpenSpec API documentation of Camunda BPM Engine REST.
  • Provides Swagger UI archive which can be used to explore the API.
  • Supports Camunda BPM Engine 7.8

Installation and Usage

How to use with Spring Boot

In order to use the Swagger in context of a Camunda SpringBoot application, just include

<dependency>
  <groupId>org.camunda.bpm.extension.swagger</groupId>
  <artifactId>camunda-bpm-swagger-json</artifactId>
  <version>7.8.0</version>
</dependency>
<dependency>
  <groupId>org.webjars</groupId>
  <artifactId>swagger-ui</artifactId>
  <version>3.1.4</version>
</dependency>

into your `pom.xml``.

  • swagger-ui-webjar - supplies the Swagger-UI application and allows access via /webjars/swagger-ui/
  • camunda-swagger-json - contains the Camunda swagger.json, so its accesible on "/swagger.json"

To use, run the main application and go to

http://localhost:8080/webjars/swagger-ui/3.1.4/index.html?docExpansion=false&url=/swagger.json

How to use in container

This project produces a WAR artifact swagger-ui.war which can be obtained under the following coordinates.

<dependency>
  <groupId>org.camunda.bpm.extension.swagger</groupId>
  <artifactId>swagger-ui</artifactId>
  <version>1.0.0</version>	  
  <type>war</type>
</dependency>

Please deploy it into the container with your Camunda ditribution (tested with Wildfly 10 Camunda distribution). To invoke the Swagger UI, call http://localhost:8080/swagger/webjars/swagger-ui/3.1.4/index.html?docExpansion=none&url=/swagger/swagger.json in your browser.

Release Notes

The versioning of this artifact is following the version of Camunda BPM (especially engine REST), since it delivers the Swagger specification of the versioned Camunda REST API. For this reason, we start with version 7.7.0.

7.8.0

  • Initial contribution

Limitations

  • Current Camunda BPM REST reference guide supplies not all information for definition of query parameters in some methods. Especially, some data type information is not present and is considered as simple string.
  • Due to the naming conventions and the size of the resulting specification, the entire History API is excluded from the spec.

Development

How to build

Checkout the code and run

mvn clean install

The profile restDocs is needed only once to generate the documentation dictionary. Make sure you are using Maven 3.3.9 or later.

If you are curious how it works, check out the maven-plugin/generator/README.md.

Maintainer

License

You can’t perform that action at this time.