Why GraphQL fits NestJS architecture - See It in Action

Why GraphQL fits NestJS architecture

📖 Scenario: You are building a backend API for a book store using NestJS. You want to explore how GraphQL fits naturally into the NestJS architecture to make your API flexible and efficient.

🎯 Goal: Understand and implement a simple NestJS GraphQL setup that shows why GraphQL fits well with NestJS architecture.

📋 What You'll Learn

Create a basic NestJS module for books

Add a configuration variable for GraphQL schema setup

Implement a GraphQL resolver for querying books

Complete the module setup to integrate GraphQL with NestJS

💡 Why This Matters

🌍 Real World

GraphQL allows clients to request exactly the data they need, reducing over-fetching and under-fetching. NestJS's modular architecture and decorators make integrating GraphQL clean and scalable.

💼 Career

Understanding how to integrate GraphQL with NestJS is valuable for backend developers building flexible APIs that serve diverse frontend clients efficiently.

1

DATA SETUP: Create a books array

Create a constant array called books with these exact objects: { id: 1, title: 'NestJS Basics' } and { id: 2, title: 'GraphQL Guide' }.

NestJS

# Create a constant array called books with two book objects
# Your code here

Need a hint?

Use const books = [ ... ] to create the array with two objects.

2

CONFIGURATION: Add GraphQL module config

Add an import statement for GraphQLModule from @nestjs/graphql and create a constant graphqlConfig with autoSchemaFile: true.

NestJS

const books = [
  { id: 1, title: 'NestJS Basics' },
  { id: 2, title: 'GraphQL Guide' }
];

// Import GraphQLModule and create graphqlConfig
# Your code here

Need a hint?

Use import { GraphQLModule } from '@nestjs/graphql'; and set const graphqlConfig = { autoSchemaFile: true }.

3

CORE LOGIC: Create a GraphQL resolver for books

Create a class called BooksResolver with a method getBooks() that returns the books array. Use the @Resolver() decorator on the class and @Query(() => [Book]) on the method. Assume Book is a GraphQL object type.

NestJS

import { GraphQLModule } from '@nestjs/graphql';

const books = [
  { id: 1, title: 'NestJS Basics' },
  { id: 2, title: 'GraphQL Guide' }
];

const graphqlConfig = {
  autoSchemaFile: true
};

// Create BooksResolver class with @Resolver and @Query
# Your code here

Need a hint?

Use @Resolver() on the class and @Query(() => [Book]) on the method returning books.

4

COMPLETION: Setup NestJS module with GraphQL integration

Create a NestJS module called BooksModule that imports GraphQLModule.forRoot(graphqlConfig) and provides BooksResolver. Use the @Module() decorator with imports and providers arrays.

NestJS

import { Resolver, Query } from '@nestjs/graphql';
import { GraphQLModule } from '@nestjs/graphql';
import { Module } from '@nestjs/common';

const books = [
  { id: 1, title: 'NestJS Basics' },
  { id: 2, title: 'GraphQL Guide' }
];

const graphqlConfig = {
  autoSchemaFile: true
};

@Resolver()
export class BooksResolver {
  @Query(() => [Book])
  getBooks() {
    return books;
  }
}

// Create BooksModule with @Module decorator
# Your code here

Need a hint?

Use @Module() with imports and providers arrays to set up the module.