import * as appsync from 'aws-cdk-lib/aws-appsync'; import * as dynamodb from 'aws-cdk-lib/aws-dynamodb'; const api = new appsync.GraphqlApi(this, 'Api', { name: 'MyAPI', schema: appsync.Schema.fromAsset('backend/schema/schema.graphql'), authorizationConfig: { defaultAuthorization: { authorizationType: appsync.AuthorizationType.API_KEY } }, });
const table = new dynamodb.Table(this, 'ItemsTable', { ... }); const dataSource = api.addDynamoDbDataSource('ItemsDS', table);
import { util } from '@aws-appsync/utils'; export function request(ctx) { const userId = ctx.identity.claims.sub; return { operation: 'GetItem', key: { id: ctx.args.id, userId } }; } Store subscription resolvers separately. Use @aws_subscribe directives in your schema to link mutations to subscriptions. Your repo should include directives. Testing Your AppSync Repo An AppSync repo without tests is risky. Implement three layers: Unit Tests (Jest + @aws-appsync/utils ) Test resolver logic without AWS infrastructure. appsync repo
An AppSync repo is not just about storing code; it is about treating your GraphQL API as a first-class, version-controlled, testable, and automatable component of your cloud architecture. Have you built an AppSync repo using a different pattern? Share your experience in the comments below, or check out the official AWS AppSync GitHub organization for more examples.
// getItem.test.js import { request } from './getItem'; test('request includes user ID from identity', () => { const ctx = { args: { id: '123' }, identity: { claims: { sub: 'user1' } } }; expect(request(ctx).key.userId).toBe('user1'); }); Deploy your API to a test environment and run real queries using aws-appsync or Apollo Client. End-to-End Tests Test the full flow: mutation → subscription → query. CI/CD Pipeline for Your AppSync Repo Your pipeline should automate every step from commit to production. Here is a GitHub Actions workflow for an AppSync repo: import * as appsync from 'aws-cdk-lib/aws-appsync'; import *
Start today: create a new GitHub repository, initialize a CDK app, add your schema.graphql , write one resolver, and deploy it. Once you have that working, expand with data sources, pipelines, and real-time subscriptions. Your future self — and your team — will thank you.
type Item { id: ID! name: String! createdAt: AWSDateTime! } type Query { getItem(id: ID!): Item } Your repo should include directives
my-appsync-repo/ ├── backend/ │ ├── schema/ │ │ └── schema.graphql │ ├── resolvers/ │ │ ├── Query/ │ │ │ ├── getItem.js │ │ │ └── listItems.js │ │ ├── Mutation/ │ │ │ ├── createItem.js │ │ │ └── updateItem.js │ │ └── pipelines/ │ ├── datasources/ │ │ └── datasources.json │ └── functions/ │ └── auth.js ├── infrastructure/ │ ├── appsync-stack.ts (CDK) │ └── config/ ├── tests/ │ ├── unit/ │ └── integration/ ├── scripts/ │ └── deploy.sh └── README.md This is the heart of your API. It defines types, queries, mutations, and subscriptions. Keep it in a single file or split it using #import directives. Example: