0

graphql-js

GraphQL for JavaScript的参考实现（A reference implementation of GraphQL for JavaScript）

官方网站
Github 资源库
主要指标

Github星跟踪图

GraphQL的JavaScript参考实现，这是Facebook创建的API的查询语言。要查看更多完整的文档，请放问 http://graphql.org/和 http://graphql.org/graphql-js/。

主要指标

概览
名称与所有者graphql/graphql-js
主编程语言TypeScript
编程语言JavaScript (语言数: 5)
平台
许可证MIT License
所有者活动
创建于2015-06-30 12:16:50
推送于2025-06-05 17:34:57
最后一次提交
发布数170
最新版本名称v16.11.0 (发布于 2025-04-26 09:58:36)
第一版名称0.1.1 (发布于 2015-07-02 13:57:00)
用户参与
星数20.2k
关注者数397
派生数2k
提交数3.2k
已启用问题?
问题数1141
打开的问题数91
拉请求数2526
打开的拉请求数72
关闭的拉请求数536
项目设置
已启用Wiki?
已存档?
是复刻?
已锁定?
是镜像?
是私有?

GraphQL.js

The JavaScript reference implementation for GraphQL, a query language for APIs created by Facebook.

npm version
Build Status
Coverage Status

See more complete documentation at https://graphql.org/ and
https://graphql.org/graphql-js/.

Looking for help? Find resources from the community.

Getting Started

An overview of GraphQL in general is available in the
README for the
Specification for GraphQL. That overview
describes a simple set of GraphQL examples that exist as tests
in this repository. A good way to get started with this repository is to walk
through that README and the corresponding tests in parallel.

Using GraphQL.js

Install GraphQL.js from npm

With yarn:

yarn add graphql

or alternatively using npm:

npm install --save graphql

GraphQL.js provides two important capabilities: building a type schema, and
serving queries against that type schema.

First, build a GraphQL type schema which maps to your code base.

import {
  graphql,
  GraphQLSchema,
  GraphQLObjectType,
  GraphQLString,
} from 'graphql';

var schema = new GraphQLSchema({
  query: new GraphQLObjectType({
    name: 'RootQueryType',
    fields: {
      hello: {
        type: GraphQLString,
        resolve() {
          return 'world';
        },
      },
    },
  }),
});

This defines a simple schema with one type and one field, that resolves
to a fixed value. The resolve function can return a value, a promise,
or an array of promises. A more complex example is included in the top
level tests directory.

Then, serve the result of a query against that type schema.

var query = '{ hello }';

graphql(schema, query).then(result => {
  // Prints
  // {
  //   data: { hello: "world" }
  // }
  console.log(result);
});

This runs a query fetching the one field defined. The graphql function will
first ensure the query is syntactically and semantically valid before executing
it, reporting errors otherwise.

var query = '{ BoyHowdy }';

graphql(schema, query).then(result => {
  // Prints
  // {
  //   errors: [
  //     { message: 'Cannot query field BoyHowdy on RootQueryType',
  //       locations: [ { line: 1, column: 3 } ] }
  //   ]
  // }
  console.log(result);
});

Want to ride the bleeding edge?

The npm branch in this repository is automatically maintained to be the last
commit to master to pass all tests, in the same form found on npm. It is
recommended to use builds deployed to npm for many reasons, but if you want to use
the latest not-yet-released version of graphql-js, you can do so by depending
directly on this branch:

npm install graphql@git://github.com/graphql/graphql-js.git#npm

Using in a Browser

GraphQL.js is a general purpose library and can be used both in a Node server
and in the browser. As an example, the GraphiQL
tool is built with GraphQL.js!

Building a project using GraphQL.js with webpack or
rollup should just work and only include
the portions of the library you use. This works because GraphQL.js is distributed
with both CommonJS (require()) and ESModule (import) files. Ensure that any
custom build configurations look for .mjs files!

Contributing

We actively welcome pull requests, learn how to
contribute.

Changelog

Changes are tracked as GitHub releases.

License

GraphQL.js is MIT-licensed.

Credits

The *.d.ts files in this project are based on DefinitelyTyped definitions written by: