GraphQL API Reference

I'm a description with a reference to myQuery

API Endpoints
https://example.com/graphql

Content from file that supports markdown

I am Intro Items content that comes from a markdown file!

Queries

myQuery

Description

A query.

Response

Returns a MyType

Arguments
Name Description
myArg - String An argument to a query.

Example

Query
query MyQuery($myArg: String) {
  myQuery(myArg: $myArg) {
    myField
  }
}
Variables
{"myArg": "abc123"}
Response
{"data": {"myQuery": {"myField": "abc123"}}}

Mutations

myMutation

Description

A mutation.

Response

Returns a MyType

Arguments
Name Description
myArg - String An argument to a mutation.

Example

Query
mutation MyMutation($myArg: String) {
  myMutation(myArg: $myArg) {
    myField
  }
}
Variables
{"myArg": "xyz789"}
Response
{
  "data": {
    "myMutation": {"myField": "abc123"}
  }
}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Example
true

MyType

Description

A type.

Fields
Field Name Description
myField - String A field on a type.
Arguments
myArg - String

An argument on a field on a type.

Example
{"myField": "xyz789"}

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"abc123"