【NestJS】初心者がNestJSを用いてGraphQLのAPIを構築をする

$ npm i -g @nestjs/cli
$ nest new project-name

$ yarn install

$ yarn run start
yarn run v1.22.22
$ nest start
[Nest] 46878  - 2024/06/23 12:34:41     LOG [NestFactory] Starting Nest application...
[Nest] 46878  - 2024/06/23 12:34:41     LOG [InstanceLoader] AppModule dependencies initialized +11ms
[Nest] 46878  - 2024/06/23 12:34:41     LOG [RoutesResolver] AppController {/}: +6ms
[Nest] 46878  - 2024/06/23 12:34:41     LOG [RouterExplorer] Mapped {/, GET} route +1ms
[Nest] 46878  - 2024/06/23 12:34:41     LOG [NestApplication] Nest application successfully started +4ms

$ tree src
src
├── app.controller.spec.ts
├── app.controller.ts
├── app.module.ts
├── app.service.ts
└── main.ts

1 directory, 5 files

$ yarn add @nestjs/graphql @nestjs/apollo @apollo/server graphql

$ nest g module author

src
├── author
│   └── author.module.ts

import { Field, Int, ObjectType } from '@nestjs/graphql';

// オブジェクト全体に対してdescriptionを記載することもできる
@ObjectType({ description: 'Authorオブジェクト' })
export class Author {
  // GraphQLには数値型はIntとFloatがあるので、Int利用を明記する
  @Field((type) => Int, { description: 'ID' })
  id: number;

  // descriptionにより、フィールドに関する説明を記載できる
  @Field((type) => String, { description: '名前' })
  name: string;

  // nullableの場合もここで指定する
  @Field((type) => Int, { nullable: true, description: '年齢' })
  age?: number;
}

import { Args, Int, Query, Resolver } from '@nestjs/graphql';
import { Author } from './author.model';

// Authorに相当するスキーマを返却することを宣言している
@Resolver((of) => Author)
export class AuthorResolver {
  // わかりやすさのため、データをベタ書き
  private authors: Author[] = [
    {
      id: 1,
      name: 'hoge',
      age: 10,
    },
    {
      id: 2,
      name: 'fuga',
    },
    {
      id: 3,
      name: 'piyo',
      age: 20,
    },
  ];

  // Authorの配列を返却することを宣言している
  // descriptionにより説明文も記載可能
  @Query((returns) => [Author], { description: 'Authorを全て取得する' })
  async getAuthor() {
    return this.authors;
  }

  // Authorを単体で返却することを宣言している
  // nullableのオプションをtrueに設定しているため、Authorオブジェクトもしくはnullが返却されることがわかる
  @Query((returns) => Author, {
    nullable: true,
    description: 'ID指定でAuthorを取得する',
  })
  // `id`というInt型の引数をリクエスト時に指定することで、idを使った絞り込みが行えることを明示している
  async findAuthor(
    @Args('id', { type: () => Int, description: '絞り込み用のID' }) id: number,
  ) {
    return this.authors.find((item) => item.id === id);
  }
}

import { Module } from '@nestjs/common';
import { AuthorResolver } from './author.resolver';

@Module({
  providers: [AuthorResolver], // ここに追加
})
export class AuthorModule {}

import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { GraphQLModule } from '@nestjs/graphql';
import { join } from 'path';
import { AuthorModule } from './author/author.module';
import { ApolloDriver } from '@nestjs/apollo';

@Module({
  imports: [
    // GraphQLを利用する際はこれを追加
    GraphQLModule.forRoot({
      driver: ApolloDriver,
      autoSchemaFile: join(process.cwd(), 'src/schema.gql'), // コードファーストで実装しているので、スキーマは自動生成される
      sortSchema: true,
    }),
    AuthorModule, // 作成したmoduleをここに記載
  ],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

$ tree src
src
├── app.controller.spec.ts
├── app.controller.ts
├── app.module.ts
├── app.service.ts
├── author
│   ├── author.model.ts
│   ├── author.module.ts
│   ├── author.resolver.spec.ts
│   └── author.resolver.ts
└── main.ts

$ yarn run start:dev

# ------------------------------------------------------
# THIS FILE WAS AUTOMATICALLY GENERATED (DO NOT MODIFY)
# ------------------------------------------------------

"""Authorオブジェクト"""
type Author {
  """年齢"""
  age: Int

  """ID"""
  id: Int!

  """名前"""
  name: String!
}

type Query {
  """ID指定でAuthorを取得する"""
  findAuthor(
    """絞り込み用のID"""
    id: Int!
  ): Author

  """Authorを全て取得する"""
  getAuthor: [Author!]!
}