GET STARTED
API POLICIES
API Gateway (GraphQL)
GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data. GraphQL provides a complete and understandable description of the data in your API, gives clients the power to ask for exactly what they need and nothing more, makes it easier to evolve APIs over time, and enables powerful developer tools.
1. Define your GraphQL schema
Every GraphQL server uses a schema to define the structure of data that clients can query. In this example, we'll create a server for querying a collection of books by title and author.
Open
schema.graphql in your preferred editor and paste the following into it:1
# Comments in GraphQL strings (such as this one) start with the hash (#) symbol.
2
3
# This "Book" type defines the queryable fields for every book in our data source.
4
type Book {
5
title: String
6
author: String
7
}
8
9
# The "Query" type is special: it lists all of the available queries that
10
# clients can execute, along with the return type for each. In this
11
# case, the "books" query returns an array of zero or more Books (defined above).
12
type Query {
13
books: [Book]
14
}
Copied!
2. Define your data set
Now that we've defined the structure of our data, we can define the data itself. Yap can fetch data from any source you connect to (including a database, a REST API, a static object storage service, or even another GraphQL server). For the purposes of this tutorial, we'll just hardcode some example data.
Add the following to the bottom of
resolvers.ts:1
const books = [
2
{
3
title: 'Harry Potter and the Chamber of Secrets',
4
author: 'J.K. Rowling',
5
},
6
{
7
title: 'Jurassic Park',
8
author: 'Michael Crichton',
9
},
10
];
Copied!
Add the following to the bottom of
resolvers.js1
// Resolvers define the technique for fetching the types defined in the
2
// schema. This resolver retrieves books from the "books" array above.
3
const resolvers = {
4
Query: {
5
books: () => books,
6
},
7
};
Copied!
3: Create an instance of Yap
YapWe've defined our schema, data set, and resolver. Now we just need to provide this information to Apollo Server when we initialize it.
Add the following to the bottom of
index.ts:1
// The Yap constructor requires three parameters: your schema
2
// definition, policies and your set of resolvers.
3
const app = new Yap({ typeDefs, resolvers, policies });
Copied!
Last modified 2yr ago