Build path
Code standards
Coding standards and best practices to apply across all connectors
Set up the project
Naming conventions, project layout, prerequisites, connector styles, and first-time configuration
Anatomy of a connector
The route skeleton and operation patterns for REST/JSON, SOAP/XML, and event connectors
Call REST endpoints
Use the gc-http-caller kamelet for every outbound REST call
Use Camel EIPs
Common Enterprise Integration Patterns: choice, multicast, splitter, doTry, and more
Transform and validate data
JSON Schema validation, JOLT and XSLT transformations, and helper bean calls
Configure properties
Common application.properties values for Camel, HTTP, CXF, retries, and headers
Configure a custom connector
Helm and SOPS configuration that takes effect at deploy time
Test and validate
Run the connector locally, deploy with kamel:dev, and write SDK-based unit tests
Reference artifacts and rules
Maven artifacts published to JFrog and the rules and anti-patterns to follow
Connector styles
Three connector styles exist — REST/JSON, SOAP/XML, and Event/Generic — and the vendor’s integration type determines which to use. Each style pairs a transformation format (JOLT or XSLT) with the appropriate HTTP kamelet. For the full comparison and the exact kamelet to use for each style, see Connector styles in Set up the project.Technology stack
Build custom connectors with the following stack:- Apache Camel-K: integration framework for Kubernetes
- Quarkus: runtime
- Maven: build and dependency management
- Java: primary development language
- GitHub Actions: continuous integration and deployment