Understanding the GraphQL Schema on Auk

The GraphQL schema is at the core of any GraphQL server. It defines the capabilities of the API and specifies how clients can access that data. A schema includes types and fields, queries and mutations, interfaces, and unions. Auk provides you the functionality to connect to a GraphQL server and explore the GraphQL schema. A GraphQL schema defines types and the fields on those types. This allows clients to ask for exactly what they need and get exactly that - nothing more and nothing less. The schema also defines queries and mutations, which are entry points into the API to read and write data. The schema is written using the Schema Definition Language (SDL). The SDL provides a way to describe types and fields, as well as queries and mutations. Here is a very simple example of a schema in SDL:

type Query {
  hello: String
}

This schema has one type, Query, and one field on that type, hello. A client could call the hello query to get the String value returned by that field. The schema sits at the core of any GraphQL server and defines the capabilities of the API. Understanding the structure and components of a GraphQL schema is fundamental to building and using GraphQL APIs. Auk’s GraphQL API platform provides you with the best experience to test and play around with GraphQL. Once connected to a GraphQL server, you can view the schema by clicking the schema icon on the sidebar. For example, try connecting to the following public server:

https://graphqlzero.almansi.me/api

You’ll see a schema similar to:

schema {
  query: Query
  mutation: Mutation
}

type Query {
  user(id: ID!): User
  post(id: ID!): Post
}

type User {
  id: ID
  name: String
  email: String
}

The schema exposes root queries (like user and post) that return typed objects. Use the Documentation panel to explore available fields and arguments.

Best Practices

Migration

Articles

Understanding the GraphQL Schema on Auk