The following are the features of Workflow App project.
- Provides the following REST APIs required to manage workflows in a Workflow Modeler
- Create - To create a workflow
- Update - To update a workflow
- Delete - To delete a workflow
- FetchWorkflows - To fetch all the workflows, search for a workflow, pagination and sorting
- FetchWorkflowById - To fetch a workflow
- Supports versioning of workflows and provides REST APIs to fetch the versions of workflows
- Records the history/audit of actions performed on workflows
Click here for more details on API documentation
click here for postman collection to test the REST APIs
This section contains list of frameworks,libraries and tools used to bootstrap this project.
- Java 11
- Spring boot 2.4.5
- Gradle 7.0 or newer
- Mongodb 4.4
- keycloak 11.0.2
- IntelliJ Idea
Set the below environment variables to bootstrap this project.
| Name | Example Value |
|---|---|
| GATEWAY_URI | https://api-gateway.techsophy.com |
| KEYCLOAK_URL_AUTH | https://keycloak.techsophy.com/auth |
| TP_MODELER_APP_MONGO_URI | mongodb://localhost:27017/techsophy-platform (Setup replica set) |
Click here to view all application properties.
In order to start working on this project follow below steps:
- Download and install JDK 11
- Download and install IntelliJ Idea
- Download and Install Keycloak and set KEYCLOAK_URL_AUTH
- Download and install MongoDB and setup replicaset.
- Run tp-cloud-config-server
- Run tp-api-gateway
- Download and install Postman - Click here to test the REST APIs
Click here to configure keycloak
The following instructions are useful to run the projet.
- Open terminal and run following cammand.
- clone this git repo using below url
git clone https://git.techsophy.com/techsophy-platform/tp-app-workflow
- Open the created folder in intellij idea
- Set the [environment variables]
- Start the application
Test the REST APIs by importing the postman collection from postman or swagger ui.