npm 包 @gql2ts/from-schema 使用教程

阅读时长 2 分钟读完

GraphQL 是一种用于 API 的查询语言,它可以描述数据之间的关系和类型,并通过一个简单的 API 对外提供数据,因此在前后端分离的架构下得到了广泛的使用。但是在前端开发过程中,我们经常需要使用 TypeScript 来进行开发,而 GraphQL 查询语句又是一个字符串类型,这就给我们的开发带来了一定的不便。为了解决这个问题,我们可以使用 @gql2ts/from-schema 这个 npm 包。

介绍

@gql2ts/from-schema 是一个可以从 GraphQL schema 生成 TypeScript 的代码的工具包,通过它我们可以把 GraphQL 查询语句转化为 TypeScript 类型。

使用示例

我们将首先安装所需的 npm 包:

接下来我们需要定义一个 GraphQL schema,我们使用一个简单的例子来说明:

我们将这个 schema 放在一个名为 schema.graphql 的文件中,接着我们可以使用 @gql2ts/from-schema 来生成 TypeScript 类型:

然后,我们得到了 types.ts 文件:

-- -------------------- ---- -------
------ ---- ----- - -
    ------- -------------------------
--

------ ---- -------- - - - -----
------ ---- ------- - -
  --- -------
  ------- -------
  -------- --------
  ---- -------
  ------ -------
--

现在我们可以看到,我们成功的将 GraphQL 的查询语句转化为了 TypeScript 类型。

总结

@gql2ts/from-schema 这个 npm 包可以让我们更方便的使用 TypeScript 来开发 GraphQL 查询语句,它的使用也十分的简单明了,我们只需要定义好 GraphQL schema ,然后使用 @gql2ts/from-schema 这个工具包就可以了。希望这篇教程对你有所帮助!

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/192732