MuleSoft Connector for GraphQL

Build 21.0.7940

Establishing a Connection

This section describes how to connect to GraphQL from your AnyPoint Studio project. You can use wizards or the XML editor in AnyPoint Studio to define connection properties in a global element. Global elements can be reused across other building blocks in your project.

Create a Connection in the Visual Editor

Complete the following steps to visually add the connector to your project and create a connection:

  1. Create a new Mule Project in Anypoint Studio.
  2. From the palette, drag the connector into your Mule flow.
  3. On the Message Flow canvas, double-click the connector icon to open the connector properties in the Properties pane.
  4. In the General section, click Add and define the GraphQL connection properties. Note that the user name and Password properties always appear here. The user name must be set as it is used as the key for the connection if connection pooling is enabled.

Create a Connection in the XML Editor

Set connection properties in the <cdata-graphql:config> element in the root of the project's XML.

Note: The user name attribute must always be included here and serves as the key for the connection if connection pooling is enabled.

  <cdata-graphql:config name="CData_GraphQL_Configuration" username="MyName" connectionProperty1="MyProperty" ... doc:name="CData GraphQL: Configuration"/> 

Before Connecting

Before a connection to data can be made, custom schema files must first be configured to model the data being accessed.

See the Modeling GraphQL Data section for a breakdown of the custom schema creation process.

Connecting to GraphQL

Set the following to connect:

  • URL: Specify the URL of the GraphQL service;
  • Location: Set this to the file path containing the custom schemas defined earlier.

The driver supports two types of authentication:

  • Basic: Set AuthScheme to Basic. You must specify the User and Password of the GraphQL service.
  • OAuth 1.0 & 2.0: Please take a look at the Using OAuth Authentication section for detailed instructions.

Configure Connector Operations

The connector is an operation-based connector; its operations correspond to SQL statements and expose other functionality such as Schema Discovery. See Using the Connector (Mule 3.8+) for more information on executing SQL to GraphQL in Mule applications.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7940