@bpmnkit/connector-gen

Generate Camunda REST connector element templates from OpenAPI/Swagger specs

Website · Documentation · GitHub · Changelog

Overview

@bpmnkit/connector-gen parses OpenAPI 3.x and Swagger 2.x specifications and generates Camunda REST connector element templates. Drop in your API spec and get a ready-to-import .json template that wires up request/response mappings automatically.

Features

• OpenAPI 3.x and Swagger 2.x support
• Generates Camunda element templates — REST connector format with input/output mappings
• Endpoint selection — generate all endpoints or filter by path/method
• FEEL expressions — pre-fills input bindings with =variable expressions
• Zero dependencies beyond yaml for YAML parsing

Installation

npm install @bpmnkit/connector-gen

Quick Start

import { generateConnectorTemplates } from "@bpmnkit/connector-gen"
import { readFileSync, writeFileSync } from "node:fs"

const spec = readFileSync("openapi.yaml", "utf8")
const templates = generateConnectorTemplates(spec)

for (const template of templates) {
  writeFileSync(`${template.id}.json`, JSON.stringify(template, null, 2))
  console.log(`Generated: ${template.name}`)
}

CLI usage (via @bpmnkit/cli)

casen connector generate openapi.yaml --out ./templates/

API Reference

function generateConnectorTemplates(
  spec: string,            // YAML or JSON OpenAPI/Swagger spec
  options?: GenerateOptions
): ConnectorTemplate[]

interface GenerateOptions {
  filter?: {
    paths?: string[]       // include only these path prefixes
    methods?: string[]     // e.g. ["get", "post"]
  }
}

Related Packages

License

MIT BPMN Kit — made by u11g