Skip to main content

Resolvers

A resolver is a function type that gets exposed to the GraphQL API and can be directly called from client apps. Resolvers allow you to add custom queries and mutations, in addition to the auto-generated CRUD operations 8base handles for you. Resolvers are used to integrate 3rd party APIs, query/coerce data, or run custom algorithms.

note

All resolver functions require unique names. You are able to deploy as many resolvers as you want to a single workspace.

8base.yml Declaration​

Resolver declarations require a handler.code, type, and schema definition. While the type value must equal 'resolver', handler.code and schema both accept relative path values to the resolver's two required files.

#
# Both the function handler and GraphQL schema definition
# must be specified using relative paths in the 8base.yml.
#
functions:
  #
  # Declare custom GraphQL resolvers like so.
  paymentResolver:
    handler:
      code: src/mutations/payment/handler.js
    type: resolver
    schema: src/mutations/payment/schema.graphql

Schema.graphql​

The schema.graphql file defines the GraphQL function and permitted response type. This describes the function name and arguments that the developer connecting to the GraphQL API has available.

type HelloResult {
  result: String!
}

extend type Mutation {
  hello(name: String): HelloResult
}

// Or alternatively...

extend type Query {
  hello(name: String): HelloResult
}

Resolver Handler​

The handler.js file defines the JavaScript function handling the GraphQL call.

module.exports = (event) => {
  const name = event.data.name;

  return {
    data: {
      result: `Hello ${name}!`,
    },
  };
};

Resolver Arguments​

To learn about the arguments that are passed to resolvers, see Custom Function Arguments.

Resolver Response​

The value returned by a resolver is allowed two properties: data and errors. The format of the data property should conform to the schema defined in the schema.graphql file.

return {
  data: {
    result: 'Hello world',
  },
  errors: [
    {
      message: 'Error message',
      code: 'error_code',
    },
  ],
};
on this page