NestJS - 预期未定义为 GraphQL 架构

JS

NestJS - 预期未定义为 GraphQL 架构

NestJS 是一个基于 typescript 的开发框架，它提供了一种高效、可扩展的方式来构建后端应用程序。在过去的几年中，GraphQL 已经变得非常受欢迎，它提供了一种灵活且强大的方式来定义和查询 API。然而，NestJS 最初并没有对 GraphQL 提供原生支持。在本文中，我们将看到如何使用 NestJS 来构建一个 GraphQL API，并使用一个案例代码来演示其用法。

为什么选择 NestJS？

在讨论如何将 NestJS 与 GraphQL 结合使用之前，让我们先了解一下为什么选择 NestJS。NestJS 提供了一种模块化的架构，使得开发者能够更好地组织和管理应用程序的各个部分。它采用了类似于 Angular 的依赖注入机制，使得代码的可维护性和可测试性得到了极大的提高。此外，NestJS 还提供了强大的路由功能，使得开发者能够轻松地定义和处理 API 的端点。

使用 NestJS 构建 GraphQL API

现在让我们来看一下如何使用 NestJS 来构建一个 GraphQL API。首先，我们需要安装一些必要的依赖项。在项目的根目录中执行以下命令：

bash
$ npm install --save @nestJS/graphql apollo-server-express graphql-tools

安装完成后，我们需要创建一个 GraphQL 模块。在 src 目录下创建一个名为 graph.module.ts 的文件，并添加以下代码：

typescript
import { Module } from '@nestJS/common';
import { GraphQLModule } from '@nestJS/graphql';
@Module({
  imports: [
    GraphQLModule.forRoot({
      autoSchemaFile: 'schema.gql',
    }),
  ],
})
export class GraphModule {}

在上述代码中，我们使用了 GraphQLModule 来配置我们的 GraphQL 服务器。autoSchemaFile 选项指定了我们的 schema 文件的路径。

接下来，我们需要创建一个 GraphQL 控制器。在 src 目录下创建一个名为 graph.controller.ts 的文件，并添加以下代码：

typescript
import { Controller, Get } from '@nestJS/common';
import { Query } from '@nestJS/graphql';
import { MyService } from './my.service';
@Controller('graph')
export class GraphController {
  constructor(private readonly myService: MyService) {}
  @Query()
  async hello() {
    return this.myService.getHello();
  }
}

在上述代码中，我们使用了 @Query 装饰器来指定一个查询操作。在这个例子中，我们调用了一个名为 getHello 的 service 方法，并将其结果返回。

最后，我们需要创建一个服务类。在 src 目录下创建一个名为 my.service.ts 的文件，并添加以下代码：

typescript
import { Injectable } from '@nestJS/common';
@Injectable()
export class MyService {
  getHello(): string {
    return 'Hello NestJS!';
  }
}

在上述代码中，我们定义了一个名为 getHello 的方法，它返回一个简单的字符串。

使用 NestJS 的 GraphQL API

现在我们已经完成了 GraphQL API 的构建，让我们来看一下如何使用它。启动应用程序后，我们可以通过访问 http://localhost:3000/graph 来访问 GraphQL Playground。

在 Playground 中，我们可以使用以下查询来测试我们的 API：

graphql
query {
  hello
}

这个查询将返回一个包含 "Hello NestJS!" 的结果。

在本文中，我们介绍了如何使用 NestJS 来构建一个 GraphQL API。我们看到了 NestJS 提供的优秀的模块化架构和便捷的路由功能。通过使用 NestJS 的 GraphQL 模块，我们可以轻松地构建和管理复杂的 GraphQL API。希望这个案例代码能够帮助你更好地理解和使用 NestJS 和 GraphQL。