介绍
generator-ptz-graphql 是一个可以快速创建 GraphQL API 的 Yeoman 生成器。使用该生成器可以自动生成包含 GraphQL API 的文件结构，并支持添加数据源、自定义类型等功能。本文将介绍如何使用该生成器创建 GraphQL API 以及对其进行定制。
安装
使用 npm 进行全局安装：
npm install -g yo generator-ptz-graphql
安装完成后，即可使用 yo 命令创建 GraphQL API。
使用
使用 yo 命令创建新项目：
yo ptz-graphql
根据提示输入项目信息，并选择需要的数据源和类型。生成器会根据所选的数据源和类型创建需要的相应的文件。
-- -------------------- ---- -------
-- ----
--------
-------------
----
------------
--------------
--------------
------
--------
--------
-------
--------
---------
----------
------------
---------其中，dataSources 目录存放数据源文件，在该文件夹下创建新的数据源文件即可在 GraphQL API 中使用。types 目录存放 GraphQL 类型定义文件，在该文件夹下创建新的类型定义文件即可在 GraphQL API 中使用。schema 目录下的 index.js 文件为 GraphQL API 的入口文件，所有的数据源和类型定义都会在该文件中被引入并导出。server.js 文件为 GraphQL API 的服务器文件，用于启动 GraphQL API 服务。
定制
generator-ptz-graphql 支持多种定制方式，包括添加新的数据源、修改默认的类型、自定义 GraphQL API 的入口文件等。
添加新的数据源
在 dataSources 目录下创建一个新的数据源文件：
-- -------------------- ---- -------
-- ----------------------------
----- ------------- -
----- --------- -
-- -------
-
-
-------------- - --------------在 schema 目录下的 index.js 文件中引入并创建新的数据源：
-- -------------------- ---- ------- -- --------------- ----- ------------- - ---------------------------------------- ----- --------- - - -- --------- -- -- ----- ----------- - -- -- -- -------------- --- ---------------- --- -------------- - - ---------- ------------ --
在 GraphQL 中即可通过 newDataSource 对象调用该数据源的方法：
-- -------------------- ---- -------
- ------- --
----- -
-------- ------------- -
----
-
-
- ------- --
-
------- -
---------- -
------- ----
-
-
-修改默认的类型
在 types 目录下创建新的类型定义文件：
-- -------------------- ---- ------- -- ---------------- ----- ----------- - ----------------------------------- ----- ------- - ------------------- - - -------- --- -------------- - --------
在 schema 目录下的 index.js 文件中引入并导出新的类型定义：
-- -------------------- ---- ------- -- --------------- ----- ------- - ---------------------------- ----- --------- - - -- --------- -- -- ----- ----------- - -- -- -- -- ---- ------- -- --- ----- -------- - - -------- -- --------- ------------------------------------------ -- -------------- - - ---------- ------------ --------- --
在 GraphQL API 中即可使用新的类型：
-- -------------------- ---- -------
- ------- --
----- -
------- -
-----
-
-
- ------- --
-
------- -
---------- -
-------- ----
-
-
-自定义入口文件
在 schema 目录下创建自定义入口文件：
-- -------------------- ---- -------
-- ---------------------
----- - ------------ - - -------------------------
----- --------- - -
-- --------- --
--
----- ----------- - -- -- --
-- ---- ------- --
---
----- -------- - -
-- ---- ----------- --
--
----- ------ - --- -------------- --------- ---------- ----------- ---
---------------
-------- --- -- -- -
------------------- ----- -- ---------
---运行 GraphQL API：
node ./schema/customIndex.js
示例
本文提供一个示例项目，以演示如何使用 generator-ptz-graphql 创建 GraphQL API。
安装
使用 npm 安装依赖：
npm install
运行
运行 GraphQL API：
npm start
运行完成后即可在浏览器中访问 GraphiQL：http://localhost:4000/graphql
测试
使用 Jest 进行单元测试：
npm test
结论
通过 generator-ptz-graphql 快速创建 GraphQL API，不仅可以节省时间，还可以通过可定制的方式满足项目需求。希望本文对大家有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055be081e8991b448d989d