Skip to content

Developer Workflow

Talisman Karavan

This document outlines the common workflow for developers creating integration microservices using the Talisman Platform.

Overview

Creating an integration microservice involves the following steps:

graph TD
  A([Create Project]) --> B(["Create Route(s)"]);
  A -->  |if needed| C(["Create REST Service(s)"]);
  A -->  |if needed| D(["Create Bean(s)"]);
  B -->  R([Run in Developer Mode]);
  D -->  R;
  R -->  DB([Build and Deploy]);
  C --> GW([Espose API])
  GW --> R
  DB --> M([Monitor])
  M:::talisman
  GW:::talisman
  classDef talisman fill:#2564eb25,stroke:#2564eb
  1. Create a Project
  2. Create Routes
  3. Create REST Services
  4. Create Beans
  5. Run in Developer Mode
  6. Build and Deploy
  7. Expose REST API (optional) Talisman
  8. Monitor with Dashboard (optional) Talisman

Below are the detailed steps involved in each phase of the development process.

Project Creation

Begin by creating a new project within Talisman. This establishes a dedicated workspace for your integration microservice.

Here you'll build the core logic of your microservice by defining various integration elements:

Routes

These are fundamental to Talisman and represent the sequence of processing steps a message takes during its journey. Each route defines how data within the message is transformed and manipulated. Follow the guide on creating Routes.

REST Services (Optional)

Talisman allows you to build RESTful services alongside your integration logic. These services can expose functionalities of your microservice to external applications. Follow the guide on creating REST services.

Beans (Optional)

Beans provide a configuration mechanism for classic components like SQL data sources or JMS connection factories. They allow you to manage these external dependencies within your microservice. Follow the guide on creating Beans.

Run in Developer Mode

To facilitate rapid development and testing, the Talisman Platform offers a developer mode. This mode allows you to run your integration in a dedicated container, complete with hot reload capabilities, a developer console, and the ability to trace and examine message exchanges in real-time.

Follow the Developer Mode guide to set up and start using these features effectively.

Build and Deploy

Once you've implemented your integration logic and confirmed its behavior in developer mode, you can proceed to building and deploying your microservice. Talisman provides an automation process to package and deploy your microservice.

Follow the Build and Deployment Guide

Expose REST API

Talisman

Talisman's built-in API Gateway eliminates the need for complex configuration or separate API management tools. Simply create your REST services within Talisman, and the API Gateway automatically publishes them, making them readily available for consumption.

Follow the Gateway Configuration

Monitor with Dashboard

Talisman

The Dashboard feature provides a comprehensive solution for monitoring and ensuring the smooth operation of integrations within your system. It offers observability, monitoring capabilities out of the box. More information about Monitoring and Dashboard