RetailCRM-Mirror/graphql-php
1
0
Fork 0
mirror of https://github.com/retailcrm/graphql-php.git synced 2024-11-25 14:26:08 +03:00
Code Issues Projects Releases Wiki Activity
A PHP port of GraphQL reference implementation
566 Commits 5 Branches 62 Tags 4.1 MiB
PHP 100%
022c490011
Go to file
Daniel Tschinder 022c490011 RFC: Descriptions as strings 
As discussed in facebook/graphql#90

This proposes replacing leading comment blocks as descriptions in the schema definition language with leading strings (typically block strings).

While I think there is some reduced ergonomics of using a string literal instead of a comment to write descriptions (unless perhaps you are accustomed to Python or Clojure), there are some compelling advantages:

* Descriptions are first-class in the AST of the schema definition language.
* Comments can remain "ignored" characters.
* No ambiguity between commented out regions and descriptions.

Specific to this reference implementation, since this is a breaking change and comment descriptions in the experimental SDL have fairly wide usage, I've left the comment description implementation intact and allow it to be enabled via an option. This should help with allowing upgrading with minimal impact on existing codebases and aid in automated transforms.

BREAKING CHANGE: This does not parse descriptions from comments by default anymore and the value of description in Nodes changed from string to StringValueNode
2018-02-10 18:44:51 +01:00
benchmarks Removed schema descriptor (as lazy loading of types can work without it now) 2017-08-14 01:42:02 +07:00
docs Added graphql-upload to the list of complementary tools 2018-01-19 13:58:07 +07:00
examples Update graphql.php 2017-10-18 16:34:14 +03:00
src RFC: Descriptions as strings 2018-02-10 18:44:51 +01:00
tests RFC: Descriptions as strings 2018-02-10 18:44:51 +01:00
tools Docblocks improvements 2017-08-20 22:10:13 +07:00
.gitattributes update ignore files 2018-01-02 10:02:18 -05:00
.gitignore Updated .gitignore 2015-07-16 00:13:12 +06:00
.travis.yml Server: fixed broken Travis build 2017-08-15 21:56:21 +07:00
CHANGELOG.md v0.11.5 2017-12-12 16:03:21 +07:00
composer.json Switched license to MIT for full compatibility with graphql-js 2018-01-19 14:12:52 +07:00
CONTRIBUTING.md Added CONTRIBUTING.md and updated README.md 2017-08-22 17:05:54 +07:00
LICENSE Switched license to MIT for full compatibility with graphql-js 2018-01-19 14:12:52 +07:00
mkdocs.yml Documentation improvements 2017-08-20 22:10:37 +07:00
phpbench.json Added phpbench for benchmarking 2016-09-14 18:41:02 +07:00
phpunit.xml.dist Changed ReactPromiseAdapter::all to preserve the array key order and added tests 2016-12-22 15:08:28 +02:00
README.md Added entry about graphql.org in the README + minor README tweaks 2017-08-22 17:24:17 +07:00
UPGRADE.md Exclude nulls from serialized AST 2018-01-13 16:25:06 +07:00

README.md

graphql-php

Build Status Coverage Status Latest Stable Version License

This is a PHP implementation of the GraphQL specification based on the reference implementation in JavaScript.

Installation

Via composer:

composer require webonyx/graphql-php

Documentation

Full documentation is available on the Documentation site as well as in the docs folder of the distribution.

If you don't know what GraphQL is, visit this official website by the Facebook engineering team.

Examples

There are several ready examples in the examples folder of the distribution with specific README file per example.

Contribute

Please refer to CONTRIBUTING.md for information on how to contribute.

Old README.md

Here is a link to the old README.md.

Keep in mind that it relates to the version 0.9.x. It may contain outdated information for newer versions (even though we try to preserve backwards compatibility).