This guide will walk you through the process of setting up API Key authentication for your Graphweaver project. API Key authentication is a straightforward way to control access to your GraphQL API for machine-to-machine communication.

This guide will also use an Sqlite database as an example data provider. Feel free to follow along or replace with your own data source as needed.

Let's get started.

Prerequisites

• Node.js and npm/pnpm: Make sure you have Node.js 20 or above along with npm and pnpm (8+) installed on your system.
• Some of the commands use curl and sqlite3 from the command line. These can be substituted with your own tools if you do not have them

Steps

Initialise a New Graphweaver Project

npx graphweaver@latest init

• You'll be prompted to name your project (e.g., example ).
• For this example choose the "Mikro-orm Sqlite backend". However, if you have a different datasource then use that.
• Confirm the creation of the new Graphweaver app.

Install Dependencies

cd example
pnpm add @exogee/graphweaver-auth