mirror of
https://github.com/retailcrm/graphql-php.git
synced 2024-11-22 21:06:05 +03:00
140 lines
3.6 KiB
Markdown
140 lines
3.6 KiB
Markdown
# Overview
|
|
GraphQL is data-centric. On the very top level it is built around three major concepts:
|
|
**Schema**, **Query** and **Mutation**.
|
|
|
|
You are expected to express your application as **Schema** (aka Type System) and expose it
|
|
with single HTTP endpoint (e.g. using our [standard server](executing-queries.md#using-server)).
|
|
Application clients (e.g. web or mobile clients) send **Queries**
|
|
to this endpoint to request structured data and **Mutations** to perform changes (usually with HTTP POST method).
|
|
|
|
## Queries
|
|
Queries are expressed in simple language that resembles JSON:
|
|
|
|
```graphql
|
|
{
|
|
hero {
|
|
name
|
|
friends {
|
|
name
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
It was designed to mirror the structure of expected response:
|
|
```json
|
|
{
|
|
"hero": {
|
|
"name": "R2-D2",
|
|
"friends": [
|
|
{"name": "Luke Skywalker"},
|
|
{"name": "Han Solo"},
|
|
{"name": "Leia Organa"}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
**graphql-php** runtime parses Queries, makes sure that they are valid for given Type System
|
|
and executes using [data fetching tools](data-fetching.md) provided by you
|
|
as a part of integration. Queries are supposed to be idempotent.
|
|
|
|
## Mutations
|
|
Mutations use advanced features of the very same query language (like arguments and variables)
|
|
and have only semantic difference from Queries:
|
|
|
|
```graphql
|
|
mutation CreateReviewForEpisode($ep: Episode!, $review: ReviewInput!) {
|
|
createReview(episode: $ep, review: $review) {
|
|
stars
|
|
commentary
|
|
}
|
|
}
|
|
```
|
|
Variables `$ep` and `$review` are sent alongside with mutation. Full HTTP request might look like this:
|
|
```json
|
|
// POST /graphql-endpoint
|
|
// Content-Type: application/javascript
|
|
//
|
|
{
|
|
"query": "mutation CreateReviewForEpisode...",
|
|
"variables": {
|
|
"ep": "JEDI",
|
|
"review": {
|
|
"stars": 5,
|
|
"commentary": "This is a great movie!"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
As you see variables may include complex objects and they will be correctly validated by
|
|
**graphql-php** runtime.
|
|
|
|
Another nice feature of GraphQL mutations is that they also hold the query for data to be
|
|
returned after mutation. In our example mutation will return:
|
|
```
|
|
{
|
|
"createReview": {
|
|
"stars": 5,
|
|
"commentary": "This is a great movie!"
|
|
}
|
|
}
|
|
```
|
|
|
|
# Type System
|
|
Conceptually GraphQL type is a collection of fields. Each field in turn
|
|
has it's own type which allows to build complex hierarchies.
|
|
|
|
Quick example on pseudo-language:
|
|
```
|
|
type BlogPost {
|
|
title: String!
|
|
author: User
|
|
body: String
|
|
}
|
|
|
|
type User {
|
|
id: Id!
|
|
firstName: String
|
|
lastName: String
|
|
}
|
|
```
|
|
|
|
Type system is a heart of GraphQL integration. That's where **graphql-php** comes into play.
|
|
|
|
It provides following tools and primitives to describe your App as hierarchy of types:
|
|
|
|
* Primitives for defining **objects** and **interfaces**
|
|
* Primitives for defining **enumerations** and **unions**
|
|
* Primitives for defining custom **scalar types**
|
|
* Built-in scalar types: `ID`, `String`, `Int`, `Float`, `Boolean`
|
|
* Built-in type modifiers: `ListOf` and `NonNull`
|
|
|
|
Same example expressed in **graphql-php**:
|
|
```php
|
|
<?php
|
|
use GraphQL\Type\Definition\Type;
|
|
use GraphQL\Type\Definition\ObjectType;
|
|
|
|
$userType = new ObjectType([
|
|
'name' => 'User',
|
|
'fields' => [
|
|
'id' => Type::nonNull(Type::id()),
|
|
'firstName' => Type::string(),
|
|
'lastName' => Type::string()
|
|
]
|
|
]);
|
|
|
|
$blogPostType = new ObjectType([
|
|
'name' => 'BlogPost',
|
|
'fields' => [
|
|
'title' => Type::nonNull(Type::string()),
|
|
'author' => $userType
|
|
]
|
|
]);
|
|
```
|
|
|
|
# Further Reading
|
|
To get deeper understanding of GraphQL concepts - [read the docs on official GraphQL website](http://graphql.org/learn/)
|
|
|
|
To get started with **graphql-php** - continue to next section ["Getting Started"](getting-started.md)
|