Fredi Bach FrediBach

Tutorial: Designing a GraphQL API

This tutorial was created by Shopify for internal purposes. We've created a public version of it since we think it's useful to anyone creating a GraphQL API.

It's based on lessons learned from creating and evolving production schemas at Shopify over almost 3 years. The tutorial has evolved and will continue to change in the future so nothing is set in stone.

	You are Manus, an AI agent created by the Manus team.

	You excel at the following tasks:
	1. Information gathering, fact-checking, and documentation
	2. Data processing, analysis, and visualization
	3. Writing multi-chapter articles and in-depth research reports
	4. Creating websites, applications, and tools
	5. Using programming to solve various problems beyond development
	6. Various tasks that can be accomplished using computers and the internet

	{
	"version": 2,
	"name": "fakeql",
	"alias": ["fakeql.com", "www.fakeql.com"],
	"env": {
	"DB_USER": "@db-user",
	"DB_PASS": "@db-pass"
	},
	"regions": [
	"cdg1"

	{
	posts: [
	{ id: 1, title: "Lorem Ipsum", views: 254, user_id: 1 },
	{ id: 100, title: "Sic Dolor amet", views: 65, user_id: 10 },
	],
	users: [
	{ id: 1, name: "John Doe" },
	{ id: 10, name: "Jane Doe" }
	],
	comments: [

	module.exports = {
	users: [
	{ id: 1, name: 'Fredi Bach', country: 'CH', birthday: '1975-09-03', sex: 'm', email: '[email protected]', userStatus_id: 2, registered: '2018-06-22T09:02:11+01:00', file_id: 1 },
	{ id: 2, name: 'Samuel Patzen', country: 'CH', birthday: '1978-02-01', sex: 'm', email: '[email protected]', userStatus_id: 2, registered: '2018-07-01T09:05:11+01:00' },
	{ id: 3, name: 'Hans Muster', country: 'CH', birthday: '1978-02-01', sex: 'm', email: '[email protected]', userStatus_id: 1, registered: '2018-04-01T09:04:11+01:00' }
	],
	userStatuses: [
	{ id: 1, key: 'inactive' },
	{ id: 2, key: 'active' },
	{ id: 3, key: 'blocked' }

	module.exports = {
	users: [
	{ id: 1, name: 'Fredi Bach', country: 'CH', birthday: '1975-09-03', sex: 'm', email: '[email protected]', userStatus_id: 2, date: '2018-06-22', file_id: 1 },
	{ id: 2, name: 'Samuel Patzen', country: 'CH', birthday: '1978-02-01', sex: 'm', email: '[email protected]', userStatus_id: 2, date: '2018-07-01' },
	{ id: 3, name: 'Hans Muster', country: 'CH', birthday: '1978-02-01', sex: 'm', email: '[email protected]', userStatus_id: 1, date: '2018-04-01' }
	],
	userStatuses: [
	{ id: 1, key: 'inactive' },
	{ id: 2, key: 'active' },
	{ id: 3, key: 'blocked' }

	type Blog @fake(amount: 10) {
	title: String @fake(type: "headlineMedium")
	comments: [Comment!]! @fake(min: 0, max: 100, distribution: "normal")
	...
	}

	query recentPosts {
	allPosts (
	sortField: "date",
	sortOrder: "DESC",
	page: 0,
	perPage: 10
	) {
	id
	title
	content

	...
	users: [
	{
	id: 123,
	name: "John Doe",
	email: "[email protected]"
	},
	{
	id: 456,
	name: "Jane Doe",