Skip to content
v1.0.0

Query builder

Loading the schema in the Builder, ticking fields, and turning an argument into a variable. Narrated, with sound. The dark and light versions follow the site's theme.

The Builder tab in the side panel composes a query by clicking through the active tab’s schema. Load the schema first with Load schema in the tab, or Run / Refresh schema.

Pick Query, Mutation or Subscription (only the roots the schema has) and tick fields. Parents are added as needed, and an object field with nothing under it is written as { __typename }. Unions and interfaces offer ... on Type groups. Unticking removes a field and any parent left empty.

A ticked field shows its arguments. Scalars take a typed value, enums and booleans a select, input objects and lists GraphQL syntax or JSON. An invalid value shows an error and isn’t applied.

Required arguments start as variables. The Variable toggle on any argument adds $name: Type to the operation and a stub to Variables, and removes both again when the variable is no longer used.

The query text is the only source of truth. Typing in the editor updates the checkboxes. The builder rewrites only the operation it edits, so other operations and the text between them stay as they are.

With a syntax error, several operations and none selected, or a query over 200,000 characters, the builder is read-only with a note. Fragments and directives are never rewritten, and fields the schema doesn’t know are listed under “Not in the schema” with a Remove button.