前言
GraphQL在现代Web开发中得到了广泛应用，并成为了前后端通信的新标准。GraphQL通常需要在开发过程中有文档化的支持，方便开发者理解、使用和测试。其中，graphql-docs-generator就是一个npm包，用于生成GraphQL Schema的Markdown文档。
本文将详细介绍如何安装和使用graphql-docs-generator包，并给出实际示例代码，以便于了解和学习。
安装
首先，需要安装以下软件工具：
- Node.js (v12以上版本)
- npm (Node.js安装后默认安装)
使用npm安装graphql-docs-generator，执行以下命令：
npm install -g graphql-docs-generator
使用
使用graphql-docs-generator需要两个参数：
schema: 存储GraphQL Schema的JSON文件路径output: 存储Markdown文档的路径
创建一个合法的GraphQL Schema文件，并保存为schema.json，如下所示：
-- -------------------- ---- -------
-
------- -
----------- -
------------ -
------- -------
--
--------------- -----
------------------- -----
-------- -
-
------- ---------
------- --------
--------- -
-
------- --------
------- ---
------- -
------- -------
------- -----
--------- -
------- ---------
------- -------
--------- ----
-
--
--------------- ------
-------------------- ----
-
-
--
-
------- ---------
------- -------
--------- -
-
------- --------
------- ---
------- -
------- ---------
------- ---------
--------- ----
--
--------------- ------
-------------------- ----
--
-
------- ---------
------- ---
------- -
------- ---------
------- ---------
--------- ----
--
--------------- ------
-------------------- ----
-
-
--
-
------- ---------
------- ---------
--------- -
-
------- -------
------- ---
------- -
------- ---------
------- ---------
--------- ----
--
--------------- ------
-------------------- ----
-
-
-
-
-
-
-调用命令行接口，输入以下命令：
graphql-docs-generator --schema=./schema.json --output=./schema.md
即可在当前目录生成一个名为schema.md的Markdown文件。打开文件，将看到类似于以下内容：
# Types ## Query
深入学习
graphql-docs-generator支持完整的GraphQL Schema语言定义，包括对象、基本类型、枚举、接口、联合类型、输入等等。更多详请请访问graphql-docs-generator GitHub页。
同时，graphql-docs-generator可以作为更多高级GraphQL工具的补充，如Apollo Server、graphql-js、GraphQL Playground等等。这些工具可以使您更好地构建、测试和部署GraphQL API。
示例代码
下面是一个使用graphql-docs-generator所生成的GraphQL Schema Example：
-- -------------------- ---- -------
---- ----- -
------ ------
-
---- ---- -
------ -------
------- ------
-
---- ------ -
----- -------
-
将上述代码转化为schema.json格式，并即可使用，生成的Markdown文档内容将如下所示：
-- -------------------- ---- ------- - ----- -- ----- --- ----- ------ ----- -------- -- ---- --- ----- ------ ----- --------- --- ------ ------ ----- -------- -- ------ --- ---- ------ ----- ---------
结论
graphql-docs-generator是一个方便的 npm 包，用于生成 GraphQL Schema 的 Markdown 文档，帮助开发者更好地理解和使用GraphQL。学习GraphQL以及如何使用GraphQL工具包，是提高现代web开发能力的关键之一。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005530181e8991b448d062f