Migrate GraphQL to WunderGraph

Create a WunderGraph Application

# Init a new project
npx create-wundergraph-app my-project --example simple
# Move to the project directory
cd my-project
# Install dependencies
npm i

Add npm Scripts

Add the following scripts to package.json, so you can run the WunderGraph server.

{
   "scripts": {
      "start": "wunderctl up --debug",
      "build": "wunderctl generate"
   }
}

Start the WunderGraph Server

npm run start

After starting the server, WunderGraph does some code generation. Check the server status at http://localhost:9991.

Configure MongoDB Atlas Data Source

You need to configure your MongoDB Atlas datasource. Inside your wundergraph.config.ts file add the following:

const Atlas = introspect.mongodb({
   apiNamespace: 'my_db',
   databaseURL: 'YourAtlasURL',
});
configureWunderGraphApplication({
   apis: [Atlas],
});

Add Query Operations

To work with your Atlas data, you need to add query operations. Navigate to the operations folder and create a new GraphQL file called Users.graphql and add the following:

{
   Mongo_findFirstusers {
      id
      name
      email
   }
}

Browse Data with the GraphiQL UI

After you get your WunderGraph server running and add query operations, you can use the GraphiQL user interface to explore your Atlas data through a GraphQL API. This can be useful when your app is in development. For apps in production, we recommend using WunderGraph's JSON-RPC interface (see next step).

1. With your WunderGraph server running, navigate to http://localhost:9991/graphql.

2. Add these queries to the GraphiQL user interface:

   query Users {
      db_findManyusers {
         id
         name
         email
      }
   }

3. Click the Play button.

Use WunderGraph's JSON-RPC Interface for Production

GraphiQL is good for development, but in production, you should consider using WunderGraph's JSON-RPC interface to interact with your Atlas data.

In short, WunderGraph compiles your GraphQL operations into JSON-RPC endpoints that you can call.

After running wunderctl up, WunderGraph checks the .wundergraph/operations directory for *.graphql files and processes them. For this to work, each file should contain exactly one GraphQL Operation.

Each file will be compiled into a JSON-RPC endpoint. The name of the endpoint is determined by the file name.

Here's an example JSON-RPC API query:

curl http://localhost:9991/operations/Users

Update Client Applications

Update any client applications that interact with your GraphQL API endpoints to point to the new WunderGraph endpoint URLs.

Shut Down Atlas App Services Endpoints

Once you have verified that your GraphQL API endpoints are fully migrated and operational on WunderGraph, you can delete your MongoDB Atlas App Services app to avoid unnecessary costs. As a reminder, Atlas GraphQL endpoints will no longer be supported beginning March 12, 2025.