接口
与许多类型系统一样，GraphQL 支持接口。 接口是一种抽象类型，它包含一组字段，类型必须包含这些字段才能实现该接口（更多信息请参阅此处 ）。
代码优先
使用代码优先方法时，您可以通过创建一个用从 @nestjs/graphql 导出的 @InterfaceType() 装饰器注解的抽象类来定义 GraphQL 接口。
import { Field, ID, InterfaceType } from '@nestjs/graphql';
@InterfaceType()
export abstract class Character {
@Field(() => ID)
id: string;
@Field()
name: string;
}
注意
TypeScript 接口不能用于定义 GraphQL 接口。
这将生成以下 GraphQL 模式定义语言(SDL)部分：
interface Character {
id: ID!
name: String!
}
现在要实现 Character 接口，请使用 implements 关键字：
@ObjectType({
implements: () => [Character],
})
export class Human implements Character {
id: string;
name: string;
}
提示
@ObjectType() 装饰器是从 @nestjs/graphql 包导出的。
该库生成的默认 resolveType() 函数会根据解析器方法返回的值提取类型。这意味着你必须返回类实例（不能返回字面量 JavaScript 对象）。
要提供自定义的 resolveType() 函数，请将 resolveType 属性传递给传入 @InterfaceType() 装饰器的 options 对象，如下所示：
@InterfaceType({
resolveType(book) {
if (book.colors) {
return ColoringBook;
}
return TextBook;
},
})
export abstract class Book {
@Field(() => ID)
id: string;
@Field()
title: string;
}
接口解析器
到目前为止，使用接口时，您只能与对象共享字段定义。如果您还想共享实际的字段解析器实现，可以创建一个专用的接口解析器，如下所示：
import { Resolver, ResolveField, Parent, Info } from '@nestjs/graphql';
@Resolver((type) => Character) // Reminder: Character is an interface
export class CharacterInterfaceResolver {
@ResolveField(() => [Character])
friends(
@Parent() character, // Resolved object that implements Character
@Info() { parentType }, // Type of the object that implements Character
@Args('search', { type: () => String }) searchTerm: string
) {
// 获取 character's friends
return [];
}
}
现在 friends 字段解析器会自动为所有实现 Character 接口的对象类型注册。
警告
这需要将 inheritResolversFromInterfaces 属性设置为 true 并配置在 GraphQLModule 中。
Schema first
在模式优先的方式中定义接口，只需用 SDL 创建一个 GraphQL 接口即可。
interface Character {
id: ID!
name: String!
}
然后，你可以使用类型生成功能（如快速开始章节所示）来生成对应的 TypeScript 定义：
export interface Character {
id: string;
name: string;
}
接口需要在解析器映射中添加一个额外的 __resolveType 字段，以确定接口应解析为何种类型。让我们创建一个 CharactersResolver 类并定义 __resolveType 方法：
@Resolver('Character')
export class CharactersResolver {
@ResolveField()
__resolveType(value) {
if ('age' in value) {
return Person;
}
return null;
}
}
INFO
所有装饰器均从 @nestjs/graphql 包中导出。
