Repolode
graphql

graphql/graphql-js

GraphQL 的 JavaScript 参考实现,用于构建类型化 schema 并执行查询,可在 Node.js 和浏览器中运行。

Star
20,340
Fork
2,089
未关闭 Issue
102
最近提交
17小时前

这是什么?

GraphQL.js 是 GraphQL 的 JavaScript 参考实现。GraphQL 是 Facebook 创建的 API 查询语言,本库可以定义与代码对应的类型 schema,并针对该 schema 执行查询。查询在执行前会先检查语法和语义是否有效,无效时返回结构化的错误信息。

该库以 `graphql` 包名发布在 npm 上,可同时用于 Node.js 服务端和浏览器。它同时提供 CommonJS 和 ES 模块两种构建,webpack、rollup 等打包工具只会引入实际用到的部分。浏览器端 IDE GraphiQL 即基于它构建。

项目采用 MIT 许可证,由 graphql 组织维护,并提供覆盖主要版本的版本支持策略。

核心功能

  • 01通过 JavaScript 对象和 resolver 函数构建带类型的 GraphQL schema。
  • 02执行前校验查询的语法和语义,并返回清晰的错误信息。
  • 03通过 `graphql` 函数执行查询,resolver 可返回普通值或 Promise。
  • 04同时支持 Node.js 和浏览器,提供 CommonJS 与 ES 模块两种构建。

适用场景

  • 在 Node.js 中搭建 GraphQL API 服务。
  • 在已有的 JavaScript 数据源之上增加 GraphQL 层。
  • 在浏览器中使用 GraphQL 工具,例如构建类似 GraphiQL 的 IDE。
  • 需要按需打包、只包含所用功能的客户端或服务端产物。

快速上手

  1. 1

    从 npm 安装 GraphQL.js

    npm install --save graphql
  2. 2

    构建 schema 并使用 graphql({ schema, source }) 执行查询

标签

常见问题

graphql-js 是什么?
GraphQL 的 JavaScript 参考实现,用于构建类型化 schema 并执行查询,可在 Node.js 和浏览器中运行。 GraphQL.js 是 GraphQL 的 JavaScript 参考实现。GraphQL 是 Facebook 创建的 API 查询语言,本库可以定义与代码对应的类型 schema,并针对该 schema 执行查询。查询在执行前会先检查语法和语义是否有效,无效时返回结构化的错误信息。
graphql-js 可以免费使用吗?用的什么许可证?
graphql-js 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
graphql-js 还在维护吗?
活跃维护中。graphql-js 最近一次提交是在 2026年10月20日。
graphql-js 适合用来做什么?
在 Node.js 中搭建 GraphQL API 服务。 在已有的 JavaScript 数据源之上增加 GraphQL 层。 在浏览器中使用 GraphQL 工具,例如构建类似 GraphiQL 的 IDE。 需要按需打包、只包含所用功能的客户端或服务端产物。
graphql-js 怎么安装和运行?
从 npm 安装 GraphQL.js: npm install --save graphql 构建 schema 并使用 graphql({ schema, source }) 执行查询
在哪里获取 graphql-js?
源代码和安装说明在 GitHub 上:https://github.com/graphql/graphql-js

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目