Skip to main content

GraphQL Schema

The first piece of any GraphQL API is the schema, which defines what data is made available to the client.

In Vulcan, this GraphQL schema can be generated automatically from your collection's JSON schema, so you don't have to type things twice. Just pass a SimpleSchema-compatible JSON schema as createCollection's schema property.

Viewing the Schema​

You can view your GraphQL schema using the Meteor shell. First, launch the shell from your terminal with:

meteor shell

Then, type:

Vulcan.getGraphQLSchema()

Note: if Vulcan is not defined you can import it first with import {Vulcan} from 'meteor/vulcan:lib'.

Custom Schemas​

If you need to manually add a schema, you can also do this using the addGraphQLSchema function which will add one or more GraphQL schemas to your GraphQL API:

import { addGraphQLSchema } from 'meteor/vulcan:core';

const customSchema = `
  input Custom {
    _id: String
    userId: String
    title: String
  }
`;
addGraphQLSchema(customSchema);