Using HTTP resolvers in AWS AppSync
AWS AppSync enables you to use supported data sources (that is, AWS Lambda, Amazon DynamoDB, Amazon OpenSearch Service, or Amazon Aurora) to perform various operations, in addition to any arbitrary HTTP endpoints to resolve GraphQL fields. After your HTTP endpoints are available, you can connect to them using a data source. Then, you can configure a resolver in the schema to perform GraphQL operations such as queries, mutations, and subscriptions. This tutorial walks you through some common examples.
In this tutorial you use a REST API (created using Amazon API Gateway and Lambda) with an AWS AppSync GraphQL endpoint.
Creating a REST API
You can use the following AWS CloudFormation template to set up a REST endpoint that works for this tutorial:
The AWS CloudFormation stack performs the following steps:
-
Sets up a Lambda function that contains your business logic for your microservice.
-
Sets up an API Gateway REST API with the following endpoint/method/content type combination:
API Resource Path | HTTP Method | Supported Content Type |
---|---|---|
/v1/users |
POST |
application/json |
/v1/users |
GET |
application/json |
/v1/users/1 |
GET |
application/json |
/v1/users/1 |
PUT |
application/json |
/v1/users/1 |
DELETE |
application/json |
Creating your GraphQL API
To create the GraphQL API in AWS AppSync:
-
Open the AWS AppSync console and choose Create API.
-
Choose GraphQL APIs and then choose Design from scratch. Choose Next.
-
For the API name, type
UserData
. Choose Next. -
Choose
Create GraphQL resources later
. Choose Next. -
Review your inputs and choose Create API.
The AWS AppSync console creates a new GraphQL API for you using the API key authentication mode. You can use the console to further configure your GraphQL API and run requests.
Creating a GraphQL schema
Now that you have a GraphQL API, let’s create a GraphQL schema. In the Schema editor in the AWS AppSync console, use the snippet below:
type Mutation { addUser(userInput: UserInput!): User deleteUser(id: ID!): User } type Query { getUser(id: ID): User listUser: [User!]! } type User { id: ID! username: String! firstname: String lastname: String phone: String email: String } input UserInput { id: ID! username: String! firstname: String lastname: String phone: String email: String }
Configure your HTTP data source
To configure your HTTP data source, do the following:
-
In the Data sources page in your AWS AppSync GraphQL API, choose Create data source.
-
Enter a name for the data source like
HTTP_Example
. -
In Data source type, choose HTTP endpoint.
-
Set the endpoint to the API Gateway endpoint that was created at the beginning of the tutorial. You can find your stack-generated endpoint if you navigate to the Lambda console and find your application under Applications. Inside of your application's settings, you should see an API endpoint which will be your endpoint in AWS AppSync. Make sure you don’t include the stage name as part of the endpoint. For instance, if your endpoint were
https://aaabbbcccd.execute-api.us-east-1.amazonaws.com/v1
, you would type inhttps://aaabbbcccd.execute-api.us-east-1.amazonaws.com
.
Note
At this time, only public endpoints are supported by AWS AppSync.
For more information about the certifying authorities that are recognized by the AWS AppSync service, see Certificate Authorities (CA) Recognized by AWS AppSync for HTTPS Endpoints.
Configuring resolvers
In this step, you will connect the HTTP data source to the getUser
and addUser
queries.
To set up the getUser
resolver:
-
In your AWS AppSync GraphQL API, choose the Schema tab.
-
To the right of the Schema editor, in the Resolvers pane and under the Query type, find the
getUser
field and choose Attach. -
Keep the resolver type to
Unit
and the runtime toAPPSYNC_JS
. -
In Data source name, choose the HTTP endpoint you made earlier.
-
Choose Create.
-
In the Resolver code editor, add the following snippet as your request handler:
import { util } from '@aws-appsync/utils' export function request(ctx) { return { version: '2018-05-29', method: 'GET', params: { headers: { 'Content-Type': 'application/json', }, }, resourcePath: `/v1/users/${ctx.args.id}`, } }
-
Add the following snippet as your response handler:
export function response(ctx) { const { statusCode, body } = ctx.result // if response is 200, return the response if (statusCode === 200) { return JSON.parse(body) } // if response is not 200, append the response to error block. util.appendError(body, statusCode) }
-
Choose the Query tab, and then run the following query:
query GetUser{ getUser(id:1){ id username } }
This should return the following response:
{ "data": { "getUser": { "id": "1", "username": "nadia" } } }
To set up the addUser
resolver:
-
Choose the Schema tab.
-
To the right of the Schema editor, in the Resolvers pane and under the Query type, find the
addUser
field and choose Attach. -
Keep the resolver type to
Unit
and the runtime toAPPSYNC_JS
. -
In Data source name, choose the HTTP endpoint you made earlier.
-
Choose Create.
-
In the Resolver code editor, add the following snippet as your request handler:
export function request(ctx) { return { "version": "2018-05-29", "method": "POST", "resourcePath": "/v1/users", "params":{ "headers":{ "Content-Type": "application/json" }, "body": ctx.args.userInput } } }
-
Add the following snippet as your response handler:
export function response(ctx) { if(ctx.error) { return util.error(ctx.error.message, ctx.error.type) } if (ctx.result.statusCode == 200) { return ctx.result.body } else { return util.appendError(ctx.result.body, "ctx.result.statusCode") } }
-
Choose the Query tab, and then run the following query:
mutation addUser{ addUser(userInput:{ id:"2", username:"shaggy" }){ id username } }
If you run the
getUser
query again, it should return the following response:{ "data": { "getUser": { "id": "2", "username": "shaggy" } } }
Invoking AWS Services
You can use HTTP resolvers to set up a GraphQL API interface for AWS services. HTTP requests to AWS must be signed with the Signature Version 4 process so that AWS can identify who sent them. AWS AppSync calculates the signature on your behalf when you associate an IAM role with the HTTP data source.
You provide two additional components to invoke AWS services with HTTP resolvers:
-
An IAM role with permissions to call the AWS service APIs
-
Signing configuration in the data source
For example, if you want to call the ListGraphqlApis operation with HTTP resolvers, you first create an IAM role that AWS AppSync assumes with the following policy attached:
{ "Version": "2012-10-17", "Statement": [ { "Action": [ "appsync:ListGraphqlApis" ], "Effect": "Allow", "Resource": "*" } ] }
Next, create the HTTP data source for AWS AppSync. In this example, you call
AWS AppSync in the US West (Oregon) Region. Set up the following HTTP configuration in a
file named http.json
, which includes the signing region and service
name:
{ "endpoint": "https://appsync.us-west-2.amazonaws.com/", "authorizationConfig": { "authorizationType": "AWS_IAM", "awsIamConfig": { "signingRegion": "us-west-2", "signingServiceName": "appsync" } } }
Then, use the AWS CLI to create the data source with an associated role as follows:
aws appsync create-data-source --api-id <API-ID> \ --name AWSAppSync \ --type HTTP \ --http-config file:///http.json \ --service-role-arn <ROLE-ARN>
When you attach a resolver to the field in the schema, use the following request mapping template to call AWS AppSync:
{ "version": "2018-05-29", "method": "GET", "resourcePath": "/v1/apis" }
When you run a GraphQL query for this data source, AWS AppSync signs the request using the role you provided and includes the signature in the request. The query returns a list of AWS AppSync GraphQL APIs in your account in that AWS Region.