简介
在前端开发中，GraphQL 逐渐成为了一个很受欢迎的解决方案。graphql-introspect 是一个为了方便前端开发人员在与 GraphQL API 合作时进行调试而创建的 npm 包。它提供了一些工具以帮助我们进行 GraphQL schema 的反向工程，自动生成文档，对 GraphQL API 进行调试等等。
在本文中，我们将向你介绍如何使用 npm 包 graphql-introspect 的几个主要功能。
安装
首先，我们需要通过 npm 安装 graphql-introspect：
npm install graphql-introspect --save
工具
1. introspectSchema
introspectSchema 是一个可以从 GraphQL API 中获取 schema 的函数。它需要接收一个包含 GraphQL API 端点 URL 的对象作为参数。例如，我们要获取以下 GraphQL API 的 schema：
https://graphql-pokemon2.vercel.app/
那么我们就可以使用以下代码：
const { introspectSchema } = require('graphql-introspect')
const endpoint = {
url: "https://graphql-pokemon2.vercel.app/"
}
introspectSchema(endpoint).then(console.log).catch(console.error)输出的结果会是我们获取到的 schema。
2. generateDocumentation
generateDocumentation 可以根据 schema 自动生成文档。它需要接收一个参数对象，包含 schema 和输出文档的类型。它支持以下几种类型：
- plain：生成纯文本文档。
- markdown：生成 Markdown 文档。
- html：生成 HTML 文档。
例如，我们要生成 markdown 格式的文档：
-- -------------------- ---- -------
----- - ----------------- --------------------- - - -----------------------------
----- -------- - -
---- --------------------------------------
-
--------------------------
------------ -- -
------------------------------------------ ----- -------------
--
---------------------这样我们就能生成指定格式的文档。
3. Operations
Operations 可以帮助我们生成 GraphQL 查询和突变。它需要接收 schema 和一个操作名称作为参数。
例如：
-- -------------------- ---- -------
----- - ----------------- ---------------------- ---------- - - -----------------------------
----- -------- - -
---- --------------------------------------
-
--------------------------
------------ -- -
----- --- - --- ------------------
----- ----- - ----------------------- -------- -
----- ---------
--
------------------
--
---------------------这里我们在 schema 中查找名称为 "Pokemon" 的类型，并且生成关于查询操作的代码。
总结
在本文中我们学习了 npm 包 graphql-introspect 的一些主要功能，包括 introspectSchema、generateDocumentation 和 Operations，它们能够帮助我们在与 GraphQL API 交互时进行调试和反向工程。希望这篇文章对你有所帮助！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600559ea81e8991b448d795c