---

---

【Nest.js】GraphQLのTypeScript型定義の自動生成方法まとめ

投稿日：2023年2月18日

Nest.jsでは特定のデコレータをつけたTypeScriptクラスから簡単にGraphQLのAPIを作成することができます。この記事では、作成したGraphQL APIのTypeScript型定義を自動で生成する方法について詳細に解説します。

---

はじめに

この記事について

環境

参考URL

---

実践

サンプルの環境について

.
├── nest-app
└── next-app

実践

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

// 型定義を作成する先を定義
const GQL_TS_TYPE_DIR = '../next-app/nest-generated';

@Module({
  imports: [
    GraphQLModule.forRoot<ApolloDriverConfig>({
      driver: ApolloDriver,
      debug: true,
      playground: true,
      autoSchemaFile: join(process.cwd(), 'src/schema.gql'),
      sortSchema: true,
      definitions: {
        path: join(process.cwd(), GQL_TS_TYPE_DIR, 'graphql.ts'), // TypeScriptの型定義ファイルを作成,
      },
    }),
    CatsModule,
  ],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

$ npm run start:dev

/*
 * -------------------------------------------------------
 * THIS FILE WAS AUTOMATICALLY GENERATED (DO NOT MODIFY)
 * -------------------------------------------------------
 */

/* tslint:disable */
/* eslint-disable */

export interface Cat {
    age: number;
    name: string;
    ownerName?: Nullable<number>;
}

export interface IQuery {
    cat(): Cat | Promise<Cat>;
}

type Nullable<T> = T | null;

補足：環境変数ごとに出力設定を変更する

import { ApolloDriver, ApolloDriverConfig } from '@nestjs/apollo';
import { Module } from '@nestjs/common';
import { ConfigModule, ConfigService } from '@nestjs/config';
import { GraphQLModule } from '@nestjs/graphql';
import { join } from 'path';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { CatsModule } from './cats/cats.module';

@Module({
  imports: [
    ConfigModule.forRoot(),
    GraphQLModule.forRootAsync({
      driver: ApolloDriver,
      imports: [ConfigModule],
      useFactory: async (configService: ConfigService) => {
        // 環境情報を取得
        const nodeEnv = configService.get('NODE_ENV', 'development');
        if (nodeEnv === 'development') {
          // 出力先を取得
          const gqlTsTypeDir = configService.getOrThrow('GQL_TS_TYPE_DIR');
          return {
            driver: ApolloDriver,
            debug: true,
            playground: true,
            autoSchemaFile: join(process.cwd(), 'src/schema.gql'),
            sortSchema: true,
            definitions: {
              path: join(process.cwd(), gqlTsTypeDir, 'graphql.ts'), // TypeScriptの型定義ファイルを作成,
            },
          };
        } else {
          return {
            driver: ApolloDriver,
            debug: false,
            playground: false,
            autoSchemaFile: true,
          };
        }
      },
      inject: [ConfigService],
    }),
    CatsModule,
  ],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

---

---

---