前言
在前端开发过程中，GraphQL 得到了越来越多的应用。针对 GraphQL，有很多的 npm 包可以辅助我们的开发，其中 graphql-cli-plugin-validate-schema 就是其中一个非常实用的包。它可以用来验证 GraphQL schema 是否符合规范，保证开发的GraphQL API 的正确性。
安装
使用 npm 安装 graphql-cli-plugin-validate-schema：
npm install -g graphql-cli-plugin-validate-schema
配置
使用插件
在 graphql-config.yml 中添加插件：
-- -------------------- ---- -------
------- --------------
---------- ----------------
-----------
----------------
------
- -----------------------------
- ----------------------------
- --------------------------
- -------------------------
- -----------------------------schema: GraphQL schema 的文件路径。documents: GraphQL documents 的文件路径。extensions: 插件配置。validate-schema: 插件名称。rules: 插件规则。
自定义规则
你可以配置你自己的规则或者重写默认的规则：
schema: schema.graphql
extensions:
validate-schema:
customRulesModulePath: './custom-rules'在 custom-rules.js 文件中添加自己的规则：
-- -------------------- ---- -------
-------------- - ---------- -------- -- -
------ -
----------------- ---- ------- ----- ---------- -
-- ---------- --- ------------------------ -
---------
---------------
-------
--
-
--
--
--以上代码会检测字段名，如果不是小写字母就会抛出一个错误。
使用
运行 graphql validate 命令，即可验证 GraphQL schema 是否符合规范：
graphql validate
如果你自定义了规则，你也可以使用 graphql validate 命令来验证：
graphql validate --rules no-uppercase-object-field
示例代码
-- -------------------- ---- -------
----- - -------- ----------- - - -------------------
----- ------ - -------------
---- ----- -
------ ------
-
---
----- ----- - -
----- -
-----
-
--
----- ------------------ - -----------------------------------------------------------------
-------------------------- ------ - ------ ------------------------------- -------------- -- -
-------------------
--结论
graphql-cli-plugin-validate-schema 是一个非常实用的包，帮助我们验证 GraphQL schema 是否符合规范，保证开发的 GraphQL API 的正确性。它可以用于开发阶段，也可以用于测试和部署阶段。希望本文的介绍能够帮助大家更好地使用此工具。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005726081e8991b448e88b3