前言
当我们在使用 Apollo GraphQL 作为我们的服务端架构时，我们经常需要对于 GraphQL 的数据类型进行建模。使用 apollo-server-types 这个 npm 包可以帮助我们更好地在 TypeScript 项目中建模这些数据类型。在本文中，我们将介绍如何安装和使用 apollo-server-types。
安装
在你的 TypeScript 项目中运行以下命令来安装 apollo-server-types：
npm install apollo-server-types
使用
下面我们将通过一个简单的示例来演示如何使用 apollo-server-types。
假设我们现在需要定义一个简单的 User 类型，包含 id、name 和 age 三个属性。首先，我们需要在代码中导入 apollo-server-types：
import { gql } from 'apollo-server';
import { Field, ID, ObjectType } from 'apollo-server-types';接着，我们可以使用 ObjectType 来定义一个 User 类型：
-- -------------------- ---- ------- ------------------- ----- ---- - ------------- -- --- --- ------- -------- ----- ------- ------------- -- ---- ---- ------- -
注意，我们在 @Field 装饰器中使用了一个 TypeScript 的 type guard，来显式地告诉 TypeScript id 是一个 ID 类型，而 age 是一个 Int 类型。
最后，我们可以在我们的 typeDefs 中使用 gql 方法来定义这个 User 类型：
const typeDefs = gql`
type User {
id: ID!
name: String!
age: Int!
}
`;这样，我们就成功地在 TypeScript 项目中定义了一个 User 类型。
深入
除了以上示例中的 @Field 装饰器，apollo-server-types 还提供了其他一些有用的装饰器，可以帮助我们更好地建模 GraphQL 数据类型。
@ArgsType
@ArgsType 装饰器可以用来定义一个包含参数的 GraphQL 输入对象类型。例如，我们可以定义一个 UserInput 类型：
-- -------------------- ---- ------- ----------- ----- --------- - ------------- -- --- --- ------- -------- ----- ------- ------------- -- ---- ---- ------- -
@InputType
@InputType 装饰器可以用来定义一个 GraphQL 输入对象类型，用于作为某个 GraphQL 查询的输入参数。例如，我们可以定义一个 GetUserInput 类型：
@InputType()
class GetUserInput {
@Field((type) => ID)
id: string;
}@InterfaceType
@InterfaceType 装饰器可以用来定义一个 GraphQL 接口类型，可以用于多态类型的建模。例如，我们可以定义一个 Person 接口类型：
@InterfaceType('Person')
abstract class Person {
@Field((type) => ID)
id: string;
@Field()
name: string;
}@UnionType
@UnionType 装饰器可以用来定义一个 GraphQL 联合类型，用于表示多个类型的并集。例如，我们可以定义一个 SearchResult 联合类型：
-- -------------------- ---- -------
------------
----- ------------ -
------ ------------ ---------------------------- -------- - -------- -- -
-- ------- -- ------- -
------ ---------
-
-- -------- -- ------- -
------ -------
-
------ -----
-
-总结
在本文中，我们介绍了 apollo-server-types 这个 npm 包的安装和使用。我们演示了如何使用 ObjectType 装饰器来定义一个 GraphQL 对象类型。除此之外，我们还介绍了其他一些有用的装饰器，例如 @Field、@ArgsType、@InputType、@InterfaceType 和 @UnionType。希望本文能够帮助你更好地在 TypeScript 项目中建模 GraphQL 数据类型。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/109158