GraphQL Cheatsheet

GraphQL is a query language for APIs and a runtime for fulfilling queries with existing application data.

Queries

Basic Query & Response

{ status }

JSON Response:

{
  "data": {
    "status": "available"
  }
}

Nested Objects

{
  hero {
    name
    height
  }
}

Lists

{
  friends {
    name
  }
}

Arguments

{
  hero(id: "1000") {
    id
    name
  }
}

Aliases

{
  luke: hero(id: "1000") {
    name
  }
  han: hero(id: "1001") {
    name
  }
}

Operation Names & Variables

Query Definition:

query FindHero($id: String!) {
  hero(id: $id) {
    name
  }
}

Variables Payload (JSON):

{
  "id": "1000"
}

Mutations

mutation CreateReviewForEpisode($ep: Episode!, $review: ReviewInput!) {
  createReview(episode: $ep, review: $review) {
    stars
    commentary
  }
}

Inline Fragments (Union & Interface Queries)

{
  search(q: "john") {
    id
    ... on User {
      name
    }
    ... on Comment {
      body
      author {
        name
      }
    }
  }
}

Over HTTP

GET Request

fetch('https://api.example.com/graphql?query={me{name}}')

POST Request

fetch('https://api.example.com/graphql', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    query: 'query GetHero($id: String!) { hero(id: $id) { name } }',
    variables: { id: '1000' }
  })
})

Schema Definition Language (SDL)

Basic Types

type Query {
  me: User
  users(limit: Int): [User]
}

type User {
  id: ID!
  name: String
}

Built-in Scalar Types

Type Definition Keywords

Type Modifiers

Interfaces

interface Entity {
  id: ID!
}

type User implements Entity {
  id: ID!
  name: String
}

Enums

enum Direction {
  NORTH
  EAST
  SOUTH
  WEST
}

Unions

union SearchResult = Human | Droid | Starship

type Query {
  search(text: String): [SearchResult]
}

References

• GraphQL Official Documentation
• GraphQL Queries and Mutations
• GraphQL Serving over HTTP