2016-11-25 13:44:34 +03:00
|
|
|
[](https://github.com/webonyx/graphql-php)
|
|
|
|
|
[](https://travis-ci.org/webonyx/graphql-php)
|
|
|
|
|
[](https://coveralls.io/github/webonyx/graphql-php)
|
|
|
|
|
[](https://packagist.org/packages/webonyx/graphql-php)
|
|
|
|
|
[](https://packagist.org/packages/webonyx/graphql-php)
|
|
|
|
|
|
2016-10-23 18:16:32 +03:00
|
|
|
# About GraphQL
|
|
|
|
|
|
2017-08-20 18:10:37 +03:00
|
|
|
GraphQL is a modern way to build HTTP APIs consumed by the web and mobile clients.
|
2016-10-23 18:16:32 +03:00
|
|
|
It is intended to be a replacement for REST and SOAP APIs (even for **existing applications**).
|
|
|
|
|
|
|
|
|
|
GraphQL itself is a [specification](https://github.com/facebook/graphql) designed by Facebook
|
|
|
|
|
engineers. Various implementations of this specification were written
|
2017-08-20 18:10:37 +03:00
|
|
|
[in different languages and environments](http://graphql.org/code/).
|
2016-10-23 18:16:32 +03:00
|
|
|
|
2017-08-20 18:10:37 +03:00
|
|
|
Great overview of GraphQL features and benefits is presented on [the official website](http://graphql.org/).
|
2016-10-23 18:16:32 +03:00
|
|
|
All of them equally apply to this PHP implementation.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# About graphql-php
|
|
|
|
|
|
2017-08-19 22:33:31 +03:00
|
|
|
**graphql-php** is a feature-complete implementation of GraphQL specification in PHP (5.5+, 7.0+).
|
2016-11-05 19:55:51 +03:00
|
|
|
It was originally inspired by [reference JavaScript implementation](https://github.com/graphql/graphql-js)
|
|
|
|
|
published by Facebook.
|
2016-10-23 18:16:32 +03:00
|
|
|
|
|
|
|
|
This library is a thin wrapper around your existing data layer and business logic.
|
|
|
|
|
It doesn't dictate how these layers are implemented or which storage engines
|
2017-08-20 18:10:37 +03:00
|
|
|
are used. Instead, it provides tools for creating rich API for your existing app.
|
2017-08-19 22:33:31 +03:00
|
|
|
|
|
|
|
|
Library features include:
|
|
|
|
|
|
|
|
|
|
- Primitives to express your app as a [Type System](type-system/index.md)
|
|
|
|
|
- Validation and introspection of this Type System (for compatibility with tools like [GraphiQL](complementary-tools.md#tools))
|
|
|
|
|
- Parsing, validating and [executing GraphQL queries](executing-queries.md) against this Type System
|
|
|
|
|
- Rich [error reporting](error-handling.md), including query validation and execution errors
|
|
|
|
|
- Optional tools for [parsing GraphQL Type language](type-system/type-language.md)
|
|
|
|
|
- Tools for [batching requests](data-fetching.md/#solving-n1-problem) to backend storage
|
|
|
|
|
- [Async PHP platforms support](data-fetching.md/#async-php) via promises
|
|
|
|
|
- [Standard HTTP server](executing-queries.md/#using-server)
|
|
|
|
|
|
2017-08-20 18:10:37 +03:00
|
|
|
Also, several [complementary tools](complementary-tools.md) are available which provide integrations with
|
2016-11-05 19:55:51 +03:00
|
|
|
existing PHP frameworks, add support for Relay, etc.
|
2016-10-23 18:16:32 +03:00
|
|
|
|
|
|
|
|
## Current Status
|
2017-08-20 18:10:37 +03:00
|
|
|
The first version of this library (v0.1) was released on August 10th 2015.
|
2016-11-25 13:44:34 +03:00
|
|
|
|
2017-08-20 18:10:37 +03:00
|
|
|
The current version (v0.10) supports all features described by GraphQL specification
|
2016-10-23 18:16:32 +03:00
|
|
|
(including April 2016 add-ons) as well as some experimental features like
|
2017-08-20 18:10:37 +03:00
|
|
|
[Schema Language parser](type-system/type-language.md) and
|
|
|
|
|
[Schema printer](reference.md#graphqlutilsschemaprinter).
|
2016-10-23 18:16:32 +03:00
|
|
|
|
2016-12-14 16:30:08 +03:00
|
|
|
Ready for real-world usage.
|
2016-11-25 13:44:34 +03:00
|
|
|
|
|
|
|
|
## Github
|
2017-08-17 22:56:22 +03:00
|
|
|
Project source code is [hosted on GitHub](https://github.com/webonyx/graphql-php).
|
