GraphQL Schema

When working with GraphQL it is useful to have the schema for development of other projects that need to call on your GraphQL endpoint. In Payload the schema is controlled by your collections and globals and is made available to the developer or third parties, it is not necessary for developers using Payload to write schema types manually.

Schema generation script

Run the following command in a Payload project to generate your project's GraphQL schema from Payload:

1payload generate:graphQLSchema

You can run this command whenever you need to regenerate your GraphQL schema and output it to a file, and then you can use the schema for writing your own GraphQL elsewhere in other projects.

Custom output file path

1{
2  // the remainder of your config
3	graphQL: {
4		schemaOutputFile: path.resolve(__dirname, './graphql/schema.graphql'),
5	},
6}

Custom Field Schemas

For array, block, group and named tab fields, you can generate top level reusable interfaces. The following group field config:

1{
type: 'group',
name: 'meta',
interfaceName: 'SharedMeta', <-- here!!
fields: [
  {
    name: 'title',
    type: 'text',
  },
  {
    name: 'description',
    type: 'text',
  },
],
15}

will generate:

1// a top level reusable type!!
2type SharedMeta {
3  title: String
4  description: String
5}
6
7// example usage inside collection schema
8type Collection1 {
9  // ...other fields
10  meta: SharedMeta
11}

The above example outputs all your definitions to a file relative from your payload config as ./graphql/schema.graphql. By default, the file will be output to your current working directory as schema.graphql.

Adding an NPM script

Payload will automatically try and locate your config, but might not always be able to find it. For example, if you are working in a /src directory or similar, you need to tell Payload where to find your config manually by using an environment variable. If this applies to you, you can create an NPM script to make generating your types easier.

To add an NPM script to generate your types and show Payload where to find your config, open your package.json and update the scripts property to the following:

1{
2  "scripts": {
3    "generate:graphQLSchema": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts payload generate:graphQLSchema"
4  }
5}

Now you can run yarn generate:graphQLSchema to easily generate your schema.

See what others are building with Payload.

"Payload has transformed the way our clients manage content. It's an indispensable tool for any modern agency."

Deploy your entire stack in one place with Payload Cloud.

Microsoft chose Payload to tell the world about AI.

GraphQL Schema

Schema generation script

Custom output file path

Custom Field Schemas

Adding an NPM script

Querying your Documents