Overview

This guide will walk you through the process of connecting Graphweaver to a REST API. We'll use a sample REST API for illustration purposes, but you can adapt the steps to connect to your own API. An example of a REST implementation can be found in our Graphweaver Repo.

Prerequisites

Before you begin, ensure that you have the following prerequisites:

• Node.js 18 or greater installed
• pnpm version 8 or greater installed

Step 1: Project Initialisation

Create a new Graphweaver project by running the following command:

npx graphweaver@latest init

Follow the prompts to set up your project. Provide a name when prompted, and select the REST API when asked about Graphweaver backends.

Install the dependencies in your project.

cd your-project-name
pnpm i

Ensure your graphweaver instance starts with:

pnpm start

Step 2: Create Schema Entities for REST data

We need to add the entity to the API by defining what fields come back on the result objects and telling Graphweaver how to get the data. We also need to tell Graphweaver how to get the IDs back for any relationships in our data. In this example below, a Person can have 0 or more Vehicle entities linked to them.

backend/schema/person.ts