GraphQL的JavaScript参考实现,这是Facebook创建的API的查询语言。要查看更多完整的文档,请放问 http://graphql.org/和 http://graphql.org/graphql-js/。
graphql-js
GraphQL for JavaScript的参考实现(A reference implementation of GraphQL for JavaScript)
Github星跟蹤圖
概覽
名稱與所有者 | graphql/graphql-js |
---|---|
主編程語言 | TypeScript |
編程語言 | JavaScript (語言數: 4) |
平台 | |
許可證 | MIT License |
發布數 | 159 |
最新版本名稱 | v16.8.1 (發布於 2023-09-19 10:25:23) |
第一版名稱 | 0.1.1 (發布於 2015-07-02 13:57:00) |
創建於 | 2015-06-30 12:16:50 |
推送於 | 2024-04-10 19:53:15 |
最后一次提交 | |
星數 | 19.9k |
關注者數 | 402 |
派生數 | 2k |
提交數 | 3.4k |
已啟用問題? | |
問題數 | 1098 |
打開的問題數 | 167 |
拉請求數 | 2323 |
打開的拉請求數 | 112 |
關閉的拉請求數 | 414 |
已啟用Wiki? | |
已存檔? | |
是復刻? | |
已鎖定? | |
是鏡像? | |
是私有? |
GraphQL.js
The JavaScript reference implementation for GraphQL, a query language for APIs created by Facebook.
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:
- TonyYang https://github.com/TonyPythoneer
- Caleb Meredith https://github.com/calebmer
- Dominic Watson https://github.com/intellix
- Firede https://github.com/firede
- Kepennar https://github.com/kepennar
- Mikhail Novikov https://github.com/freiksenet
- Ivan Goncharov https://github.com/IvanGoncharov
- Hagai Cohen https://github.com/DxCx
- Ricardo Portugal https://github.com/rportugal
- Tim Griesser https://github.com/tgriesser
- Dylan Stewart https://github.com/dyst5422
- Alessio Dionisi https://github.com/adnsio
- Divyendu Singh https://github.com/divyenduz
- Brad Zacher https://github.com/bradzacher
- Curtis Layne https://github.com/clayne11
- Jonathan Cardoso https://github.com/JCMais
- Pavel Lang https://github.com/langpavel
- Mark Caudill https://github.com/mc0
- Martijn Walraven https://github.com/martijnwalraven
- Jed Mao https://github.com/jedmao