GraphQL cheatsheet

{ status }

Result

{ status: 'available' }

{ hero { name height } }

Result

{ hero:
    { name: "Luke Skywalker",
      height: 1.74 } }

{ friends { name } }

Result

{ friends:
    [ { name: "Luke Skywalker" },
      { name: "Han Solo" },
      { name: "R2D2" } ] }

GraphQL queries look the same for both single items or lists of items.

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

Result

{ hero:
    { id: "1000",
    { name: "Luke Skywalker" } }

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

Result

{ luke:
    { name: "Luke Skywalker" },
    han:
    { name: "Han Solo" } }

Query

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

Just to make things less ambiguous. Also, to use variables, you need an operation name.

Variables

{ id: '1000' }

Query

{ createReview($review) { id } }

Variables

{ review: { stars: 5 } }

Result

{ createReview: { id: 5291 } }

Mutations are just fields that do something when queried.

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

Great for searching.

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

type User {
  id: ID!
  name: String
}

See: sogko/graphql-shorthand-notation-cheat-sheet

Scalar types

Type	Description
Int	Integer
Float	Float
String	String
Boolean	Boolean
ID	ID

Type definitions

Definition	Description
scalar	Scalar type
type	Object type
interface	Interface type
union	Union type
enum	Enumerable type
input	Input object type

Type modifiers

Syntax	Description
String	Nullable string
String!	Required string
[String]	List of strings
[String]!	Required list of strings
[String!]!	Required list of required strings

type Mutation {
  users(params: ListUsersInput): [User]!
}

interface Entity {
  id: ID!
}

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

enum DIRECTION {
  LEFT
  RIGHT
}

type Root {
  direction: DIRECTION!
}

type Artist { ··· }
type Album { ··· }

union Result = Artist | Album

type Query {
  search(q: String): [Result]
}