GraphQL component

Overview

The GraphQL connector lets you model GraphQL endpoints and run their operations directly from Semarchy xDI.

GraphQL interactions are modeled with a dedicated GraphQL metadata object that stores the endpoint URL, HTTP security, certificates, default timeouts, and the GraphQL statements to execute. Each statement exposes a JSON response tree composed of data nodes for successful payloads and errors nodes when the server returns partial responses, mirroring the GraphQL specification.

Install the GraphQL component

If you did not install it yet, install the GraphQL component in Designer by following the component installation process.

Supported features

Feature Description

Feature	Description
Queries and mutations	Execute read and write GraphQL operations modeled in metadata, with JSON responses exposed to mappings.
Manual response design	Define nested `data` nodes and `errors` arrays that mirror the GraphQL specification, ensuring predictable mapping structures even without introspection.
Authentication	Bearer token authentication from HTTP Security metadata.
Timeout control	Configure default connect, response, read, and write timeouts per metadata node.
Partial error handling	Configure the tolerated number of partial-response errors before a mapping fails, enabling resilient integrations.

Queries and mutations

Execute read and write GraphQL operations modeled in metadata, with JSON responses exposed to mappings.

Manual response design

Define nested data nodes and errors arrays that mirror the GraphQL specification, ensuring predictable mapping structures even without introspection.

Authentication

Bearer token authentication from HTTP Security metadata.

Timeout control

Configure default connect, response, read, and write timeouts per metadata node.

Partial error handling

Configure the tolerated number of partial-response errors before a mapping fails, enabling resilient integrations.