本文将指导您如何在 NestJS 微服务架构中利用 GraphQL 定义 API 接口,并提供详细的代码示例。
首先,我们需要安装必要的 npm 包:@nestjs/graphql 用于 NestJS 中的 GraphQL 集成,以及 apollo-server-express (或其他 GraphQL 服务器,如 mercurius) 作为 GraphQL 服务器实现。 使用以下命令安装:
npm install --save @nestjs/graphql apollo-server-express graphql
接下来,在主模块 (通常是 AppModule) 中导入并配置 GraphQLModule。 forRoot() 方法用于配置,autoSchemaFile 指定自动生成的 schema 文件路径:
// app.module.ts import { Module } from '@nestjs/common'; import { GraphQLModule } from '@nestjs/graphql'; @Module({ imports: [ GraphQLModule.forRoot({ autoSchemaFile: 'schema.gql', // 自动生成的 schema 文件路径 // 其他配置... }), ], }) export class AppModule {}
然后,定义 GraphQL 类型和解析器。 使用 @ObjectType、@Field、@Query、@Mutation 等来自 @nestjs/graphql 的装饰器来定义类型和解析函数。 以下示例展示了如何定义 User 类型及其对应的查询和变异操作:
// user.resolver.ts import { Resolver, Query, Mutation, Args, Int } from '@nestjs/graphql'; import { User } from './user.entity'; import { CreateUserInput } from './dto/create-user.input'; import { UpdateUserInput } from './dto/update-user.input'; import { UserService } from './user.service'; @Resolver(() => User) export class UserResolver { constructor(private readonly userService: UserService) {} @Query(() => [User], { name: 'users' }) findAll() { return this.userService.findAll(); } @Query(() => User, { name: 'user' }) findOne(@Args('id', { type: () => Int }) id: number) { return this.userService.findOne(id); } @Mutation(() => User) create(@Args('input') input: CreateUserInput) { return this.userService.create(input); } @Mutation(() => User) update(@Args('input') input: UpdateUserInput) { return this.userService.update(input.id, input); } @Mutation(() => User) remove(@Args('id', { type: () => Int }) id: number) { return this.userService.remove(id); } }
完成以上步骤后,运行 NestJS 应用 (例如:npm run start:dev)。 GraphQL 服务默认在 /graphql 路径下可用。 使用 GraphQL Playground 测试您的 API。
最后,前端应用可以使用 Apollo Client 或其他 GraphQL 客户端库与您的 GraphQL API 交互。 以下是一个使用 Apollo Client 的示例:
import { ApolloClient, InMemoryCache, gql } from '@apollo/client'; const client = new ApolloClient({ uri: 'http://localhost:3000/graphql', cache: new InMemoryCache(), }); client.query({ query: gql` query { user(id: 1) { id name email } } `, }).then((result) => console.log(result.data));