Component generator

ByteChef command-line application

This is an application that helps you with generating components from OpenApi specifications. It is work in progress. Until the app is published, use bytechef.sh script to execute the app.

Step-by-step guide to generate connector

Crete new package with name of your connector in server/apps/libs/modules/components/yourconnector
Inside your new package create openapi.yaml file and write OpenAPI specification for your connector.
Change working directory to the BYTECHEF_HOME/cli/cli-app folder.

Generate YourConnector component/connector by executing the following command:

$ ./bytechef.sh component init --open-api-path ../../server/libs/modules/components/yourconnector/openapi.yaml --output-path ../../server/libs/modules/components --name yourconnector

Setup gradle

In file bytechef/settings.gradle.kts, add line: include("server:libs:modules:components:yourconnector")
In both files bytechef/server/ee/apps/worker-app/build.gradle.kts and bytechef/server/apps/server-app/build.gradle.kts, add line implementation(project(":server:libs:modules:components:yourconnector"))
Load gradle changes. After that IntelliJ should recognize your connector as a java module.

Connector icon

Find and download from internet the user interface icon in .svg format for your connector and put it in server/libs/modules/components/yourconnector/src/main/resources/assets/yourconnector.svg
In YourConnectorComponentHandler.class override method modifyComponent(ModifiableComponentDefinition modifiableComponentDefinition) with
```
return modifiableComponentDefinition
.customAction(true)
.icon("path:assets/yourconnector.svg");
```

Connection

If your authentication has some custom parameters then in YourConnectorComponentHandler.class override method modifyConnection(ModifiableConnectionDefinition modifiableConnectionDefinition). For example, look at ShopifyComponentHandler.class, DiscordComponentHandler.class or PipelinerComponentHandler.class.

Dynamic options

Similarly, if some parameters should have dynamic options then in YourConnectorComponentHandler.class override method modifyProperty(ActionDefinition actionDefinition, ModifiableProperty<?> modifiableProperty). For example, look at ShopifyComponentHandler.class.

Dynamic properties

To mark some object as dynamic properties type, set x-property-type: "dynamicProperties" extension as part of the object definition.