Low-code connector development
Airbyte’s low-code framework enables you to build source connectors for REST APIs via a connector builder UI or by modifying boilerplate YAML files via terminal or text editor.
Developer updates will be announced via our #help-connector-development Slack channel. If you are using the CDK, please join to stay up to date on changes and issues.
API Connectors are common and formulaic
In building and maintaining hundreds of connectors at Airbyte, we've observed that whereas API source connectors constitute the overwhelming majority of connectors, they are also the most formulaic. API connector code almost always solves small variations of these problems:
- Making requests to various endpoints under the same API URL e.g:
- Authenticating using a common auth strategy such as Oauth or API keys
- Pagination using one of the 4 ubiquitous pagination strategies: limit-offset, page-number, cursor pagination, and header link pagination
- Gracefully handling rate limiting by implementing exponential backoff, fixed-time backoff, or variable-time backoff
- Describing the schema of the data returned by the API, so that downstream warehouses can create normalized tables
- Decoding the format of the data returned by the API (e.g JSON, XML, CSV, etc..) and handling compression (GZIP, BZIP, etc..)
- Supporting incremental data exports by remembering what data was already synced, usually using date-based cursors
and so on.
A declarative, low-code paradigm commoditizes solving formulaic problems
Given that these problems each have a very finite number of solutions, we can remove the need for writing the code to build these API connectors by providing configurable off-the-shelf components to solve them. In doing so, we significantly decrease development effort and bugs while improving maintainability and accessibility. In this paradigm, instead of having to write the exact lines of code to solve this problem over and over, a developer can pick the solution to each problem from an available component, and rely on the framework to run the logic for them.
What connectors can I build using the low-code framework?
Refer to the REST API documentation for the source you want to build the connector for and answer the following questions:
- Does the REST API documentation show which HTTP method to use to retrieve data, and that the response is a JSON object?
- Do the queries return data synchronously?
- Does the API support any of the following pagination mechanisms:
- Offset count passed either by query params or request header
- Page count passed either by query params or request header
- Cursor field pointing to the URL of the next page of records
- Does the API support any of the following authentication mechanisms:
- Does the API support static schema?
- Does the endpoint have a strict rate limit? Throttling is not supported, but the connector can use exponential backoff to avoid API bans in case it gets rate limited. This can work for APIs with high rate limits, but not for those that have strict limits on a small time-window.
- Are the following features sufficient:
|Sync mode||Full refresh|
|Schema discovery||Static schemas|
|Incremental syncs||Sync checkpointing by date|
|Partition routing||lists, parent-resource id|
|Record transformation||Field selection|
|Error detection||From HTTP status code|
From error message
Derived from headers
If the answer to all questions is yes, you can use the low-code framework to build a connector for the source. If not, use the Python CDK.
- An API key for the source you want to build a connector for
- Python >= 3.9
Overview of the process
To use the low-code framework to build an REST API Source connector:
- Generate the API key or credentials for the source you want to build a connector for
- Set up the project on your local machine
- Set up your local development environment
- Use the connector builder UI to define the connector YAML manifest and test the connector
- Specify stream schemas
- Add the connector to the Airbyte platform
Connector Builder UI
The main concept powering the lowcode connector framework is the Connector Manifest, a YAML file which describes the features and functionality of the connector. The structure of this YAML file is described in more detail here.
We recommend iterating on this YAML file is via the connector builder UI as it makes it easy to inspect and debug your connector in greater detail than you would be able to through the commandline. While you can still iterate via the commandline (and the docs contain instructions for how to do it), we're investing heavily in making the UI give you iteration superpowers, so we recommend you check it out!
Configuring the YAML file
The low-code framework involves editing a boilerplate YAML file. The general structure of the YAML file is as follows:
<key-value pairs defining objects which will be reused in the YAML connector>
<list stream definitions>
<definition of connection checker>
The following table describes the components of the YAML file:
|Indicates the framework version|
|Describes the objects to be reused in the YAML connector|
|Lists the streams of the source|
|Describes how to test the connection to the source by trying to read a record from a specified list of streams and failing if no records could be read|
|A connector specification which describes the required and optional parameters which can be input by the end user to configure this connector|
Streams define the schema of the data to sync, as well as how to read it from the underlying API source. A stream generally corresponds to a resource within the API. They are analogous to tables for a relational database source.
For each stream, configure the following components:
|Name||Name of the stream|
|Primary key (Optional)||Used to uniquely identify records, enabling deduplication. Can be a string for single primary keys, a list of strings for composite primary keys, or a list of list of strings for composite primary keys consisting of nested fields|
|Schema||Describes the data to sync|
|Incremental sync||Describes the behavior of an incremental sync which enables checkpointing and replicating only the data that has changed since the last sync to a destination.|
|Data retriever||Describes how to retrieve data from the API|
|Requester||Describes how to prepare HTTP requests to send to the source API and defines the base URL and path, the request options provider, the HTTP method, authenticator, error handler components|
|Pagination||Describes how to navigate through the API's pages|
|Record Selector||Describes how to extract records from a HTTP response|
|Partition Router||Describes how to partition the stream, enabling incremental syncs and checkpointing|
|Cursor field||Field to use as stream cursor. Can either be a string, or a list of strings if the cursor is a nested field.|
|Transformations||A set of transformations to be applied on the records read from the source before emitting them to the destination|
This section is a tutorial that will guide you through the end-to-end process of implementing a low-code connector.
- Getting started
- Creating a source
- Installing dependencies
- Connecting to the API
- Reading data
- Incremental reads
For examples of production-ready config-based connectors, refer to:
The full schema definition for the YAML file can be found here.