simple api
overview

Simple API

There's a corresponding Article for the Relay API
Go to Relay API
Last updated 3 weeks ago
#simple-api

The Simple API is meant for GraphQL clients like Apollo or Lokka. If you are using Relay as your GraphQL client, check the Relay API instead.

?

Differences to the Relay API

The Simple API can be thought of as a simpler version of the Relay API. The two APIs don't differ too much in features, but mostly in usage. If you don't use Relay as a GraphQL client you probably should use the Simple API. If you decide to use Relay sometime later, you can easily switch to the Relay API or use both APIs.

?

Using the Simple API

Connecting to the Simple API

Connect your application to the endpoint of your project to make API requests. The Simple API provides several possibilities to fetch, modify or traverse your data.

?

Generated Queries

Depending on your models and relations, certain automatically generated queries are available to fetch your data.

?

Traversing the data graph

Using GraphQL, you can select the individual fields that the response of a query or mutation should contain. The GraphQL schema of your project is built according to your models and relations and allows you to traverse the data graph in your query.

?

Generated Mutations

Depending on your models and relations certain generated mutations are available that allow you to modify your data.

?

Generated Subscriptions

Depending on your models and relations, certain generated subscriptions allow you to be notified in realtime of changes to your data. All available subscriptions are automatically generated.

?

Errors

If something goes wrong when sending a query or mutation, errors are returned in the response enabling you to further investigate the issue.

?

More aboutSimple API
Simple API is supposed to be consumed by GraphQL clients such as Meteor's Apollo, Kadira's Lokka or simpler clients like curl or plain http.

Create a GraphQL backend

TUTORIAL

Relay vs. Apollo - Comparing GraphQL Clients

TUTORIAL