serverless-graphql-api

Inspired by https://github.com/boazdejong/serverless-graphql-api

Serverless GraphQL API using Lambda and DynamoDB

GraphQL Lambda Server using graphql-server-lambda from Apollo.

graphql-tools and merge-graphql-schemas are used to generate the schema.

serverless-webpack is used to transform ES6 with Babel and build the lambda.

Setup

1. Install serverless npm install -g serverless
2. Configure AWS provider a. Login to AWS console b. Navigate to IAM c. Create new user (or use existing one). Get access key and secret key d. Navigate back to your local terminal serverless config credentials --provider aws --key 1234 --secret 5678 --profile serverless-demo
3. Clone the repository and install the packages.

git clone https://github.com/abachuk/serverless-graphql-api
cd serverless-graphql-api
npm install

Deploy

Run the deploy script to create the Lambda Function and API Gateway for GraphQL. This also creates two DynamoDB tables named authors and posts

npm run deploy

Queries and Mutations

Query the GraphQL server using the GraphiQL.app. If you have Homebrew installed on OSX run

brew cask install graphiql

Mutations

The following mutations are available in this example.

createAuthor()

Create an author providing the first and last name as arguments. The id will be a generated uuid.

mutation {
  createAuthor(first_name: "Agent", last_name: "Smith") {
    id
  }
}

createPost()

Using the generated id from the author you can create a post with the following mutation. Also provide a title and duration.

mutation {
  createPost(post: "34b236e0-0734-54e7-b2cd-45ue6a3b9071", title: "Whatever", body: "my long and very interesting post") {
    id
  }
}

updateAuthor()

mutation {
  updateAuthor(id: "34b236e0-0734-54e7-b2cd-45ue6a3b9071", first_name: "Agent", last_name: "Jones") {
    id
    first_name
    last_name
  }
}

updatePost()

mutation {
  updatePost(id: "w1a0a060-091b-11e7-bd09-1092f101s7c0", author: "34b236e0-0734-54e7-b2cd-45ue6a3b9071", body:
  "even more interesting post", title: "A new title") {
    id
  }
}

Queries

Example query

{
  posts {
    id
    title
    body
    author {
      id
      first_name
      last_name
    }
  }
}

This query will return a result similar to this

{
  "data": {
    "posts": [
      {
        "id": "w1a0a055-091b-11e7-bd09-1092f101s7c1",
        "title": "Whatever",
        "body": "super duper cool blog post",
        "author": {
          "id": "99a746e0-0734-11e7-b2fd-45ae0a3b9074",
          "first_name": "Agent",
          "last_name": "Brown"
        }
      }
    ]
  }
}

DynamoDB Streams

This project also includes an example of capturing table activity with DynamoDB Streams. The record lambda function is triggered by two stream events. One for each table.

In serverless.yml:

record:
  handler: lib/handler.record
  events:
    - stream:
        type: dynamodb
        arn:
          Fn::GetAtt:
            - PostsDynamoDbTable
            - StreamArn
        batchSize: 1
    - stream:
        type: dynamodb
        arn:
          Fn::GetAtt:
            - PostsDynamoDbTable
            - StreamArn
        batchSize: 1

The stream is enabled when defining the DynamoDB table in the serverless.yml resources.

StreamSpecification:
  StreamViewType: NEW_AND_OLD_IMAGES