I built a new way of mocking GraphQL server

Introduction

Welcome! This guide will take you through the steps to create a GraphQL server using Mockingbird. Whether you’re a developer or a tester, this guide will help you set up a mock GraphQL server, create queries and mutations, and test everything out. By the end, you'll have a robust mock server that makes your development process smoother and faster.

In previous guides, we covered the basics of mocking with Mockingbird [1][2][3], These guides provided a solid foundation for using Mockingbird in various scenarios. Building on that knowledge, this guide focuses specifically on leveraging Mockingbird to mock GraphQL servers. If you’ve found our previous guides helpful, you’ll find this one equally valuable as it dives into the specifics of handling GraphQL with Mockingbird.

Let’s dive in and see how Mockingbird can simplify your GraphQL server setup and testing.

Step 1: Download and Install Mockingbird

1. Head over to the Mockingbird GitHub releases page.
2. Download the latest version.
3. Once the download is complete, open Mockingbird.

Step 2: Create a New Project or Clone an Existing One

1. When you open Mockingbird, you'll see a "Create Project" screen with three options:
   • Create New Project: Start a new project from scratch by entering a project name.
   • Clone Existing Project: Clone a project by entering the repository URL and any needed authentication details.
   • Open Existing Project: Open a project that’s already saved on your computer.

Step 3: Create a Server

1. After setting up your project, you’ll need to create a server.
2. Give your server a name.
3. Specify the port number it will run on.

Step 4: Create a Parent

1. Next, you need to create a parent for your server.
2. Choose the option to create a GraphQL parent.
3. Enter a name for the GraphQL parent.
4. Set the REST path for the GraphQL endpoint, usually /graphql.
5. Decide if the parent will be a query parent or a mutation parent using the drop-down menu.
6. If needed, specify a schema path for nested queries using dot notation (e.g., user.address).
7. Save the parent once everything is filled out.

Step 5: Create Queries or Mutations

1. In the Parent Details page, click "Add Query" or "Add Mutation" based on your parent type.
2. Enter a name for the query or mutation. This name will be the schema signature and should include parameters if necessary. For example, a query called users that takes an ID would be users(id: String).
3. For complex parameters like custom objects, use Any as the type. For example, users(param: Any).
4. Optionally, add a description.
5. Save your query or mutation.

Step 6: Add Multiple Responses to the Query or Mutation

1. Go to the Query or Mutation Details page.
2. Click "Add Response."
3. In the window that opens, enter your response. You have three options:
   • JSON: For JSON responses, you can automatically generate types. Click "Generate" to create the response type in the editor.
   • Function: For function responses, you need to manually insert the response type. Alternatively, start with a JSON response to generate the type, then switch to a function.
   • Proxy: For proxy responses, manually insert the response type, or use a JSON response to generate the type first, then switch to proxy.
4. Also, fill in the "Response Type Name" field with the main type name of the response.
5. Save the response.

Step 7: Enable Proxy Mode (Optional)

1. Mockingbird can act as a proxy server for GraphQL. If a query or mutation isn’t found locally, it forwards the request to the target server.
2. Once you get a response from the target server, you can add both the query and its response to Mockingbird from the console.

Step 8: Start the Server and Test

1. Start the server to apply your configurations.
2. After the server is running, you’ll get a link to the GraphQL playground.
3. Use this link to open the playground.
4. There will also be a button to copy a sample query for your setup.
5. Paste the sample query into the playground to verify you’re getting the desired response from the GraphQL server.

Epilogue

Mockingbird makes the complex task of mocking a GraphQL server much easier. This tool is perfect for developers and testers, allowing them to simulate various scenarios without waiting for the actual server to be built. With features like multiple response creation, type generation, and easy switching between setups, Mockingbird streamlines your development and testing processes.

Proxy Mode

One of Mockingbird’s standout features is its ability to act as a proxy server, even for GraphQL. This feature is incredibly useful when you have queries or mutations that are not defined locally in Mockingbird. Here’s how it works:

• Forwarding Requests: When a query or mutation isn’t found in your local Mockingbird setup, Mockingbird forwards the request to the target server. This ensures that you always get a response, even if it’s not yet mocked locally.

• Capturing Responses: Once Mockingbird receives the response from the target server, it allows you to add both the query and its response to your local Mockingbird setup. This means you can quickly build out your mock server using real data without manually defining every response upfront.

• Simplifying Setup: This proxy feature makes setting up a mock server with real data quick and hassle-free. Instead of having to manually enter every possible query and response, you can let Mockingbird capture and store them for you as they come in.

This feature is perfect for quickly setting up realistic mock environments, especially in dynamic development and testing scenarios. It saves you time and effort, ensuring that your mock server is as accurate and comprehensive as possible with minimal manual intervention.

Whether you’re developing new features, running automated tests, or setting up complex integrations, Mockingbird’s proxy capabilities save you time and reduce errors. Its flexibility and ease of use make it a crucial tool for modern software development and testing environments.

By using Mockingbird, you can focus on building and refining your application, knowing your mock environment is reliable and efficient.

Join the Community

If this guide has helped you why not give it a try? You can download Mockingbird and start building your own mock servers today. If you like what you see, a star on GitHub would mean a lot—it’s a small way to show support for the project. And if you’re interested in contributing, we’d love to have you onboard. Your feedback and contributions are what make Mockingbird better with each update.