Skip to content

vicary/serverless-appsync-plugin

 
 

Repository files navigation

Tests All Contributors

Deploy AppSync API's in minutes using this Serverless plugin.

Notice

This is a fork of the original serverless-appsync-plugin with two modifications:

  1. A new option appSync.apiId to support an existing AppSync API.
  2. Replace the schema conversion with appsync-schema-converter.

Minimum requirements

Installation

npm install serverless-appsync-plugin

Quick start

service: my-app

plugins:
  - serverless-appsync-plugin

provider:
  name: aws

appSync:
  name: my-api
  authentication:
    type: API_KEY

  resolvers:
    Query.user:
      dataSource: my-table

  dataSources:
    my-table:
      type: AMAZON_DYNAMODB
      config:
        tableName: ${sls:stage}-data

Configuration

CLI

This plugin adds some useful CLI commands. See CLI commands documentation

Variables

This plugin exports some handy variables that you can use in your yml files to reference some values generated by CloudFormation:

  • ${appsync:id}: The id of the AppSync API
  • ${appsync:url}: The URL of the AppSync API
  • ${appsync:arn}: The ARN of the AppSync API
  • ${appsync:apiKey.[NAME]}: An API key

Example:

provider:
  environment:
    APPSYNC_ID: ${appsync:id}
    APPSYNC_ARN: ${appsync:arn}
    APPSYNC_URL: ${appsync:url}
    APPSYNC_API_KEY: ${appsync:apiKey.myKey}

appSync:
  name: my-api

  authentication:
    type: API_KEY

  apiKeys:
    - name: myKey

Upgrading from v1

To upgrade form v1 of this plugin, follow this guide

Contributing

If you have any questions, issue, feature request, please feel free to open an issue.

You are also very welcome to open a PR and we will gladly review it.

Resources

Tools

  • Mapping Tool: Quickly Build and Debug AppSync & API Gateway Mapping Templates
  • GraphBolt: A professional desktop app solution for building, testing, and debugging AppSync APIs.
  • AppSync Resolver Autocomplete: VSCode extension. Autocomplete support for VTL template files.

Video tutorials

Blog tutorial

Contributors โœจ

Thanks goes to these wonderful people ๐Ÿ‘


Benoรฎt Bourรฉ

๐Ÿšง ๐Ÿ’ป

Siddharth Gupta

๐Ÿ’ป

Nik Graf

๐Ÿ’ป

Charles Killer

๐Ÿ’ป

jpstrikesback

๐Ÿ’ป

ZY

๐Ÿ’ป

Francis Upton IV

๐Ÿ’ป

Ilya Shmygol

๐Ÿ’ป

Maddi Joyce

๐Ÿ’ป

sebflipper

๐Ÿ’ป

Erez Rokah

๐Ÿ’ป

Akshay Kadam (A2K)

๐Ÿ’ป

Anton

๐Ÿ’ป

Burkhard Reffeling

๐Ÿ’ป

Dean Koลกtomaj

๐Ÿ’ป

Vincent Lesierse

๐Ÿ’ป

lulzneko

๐Ÿ’ป

thomas michael wallace

๐Ÿ’ป

Adnene KHALFA

๐Ÿ’ป

Alex Rozn

๐Ÿ’ป

Eric Chan

๐Ÿ’ป

Joseph

๐Ÿ’ป

Miha Erลพen

๐Ÿ’ป

Mike Fogel

๐Ÿ’ป

Philipp Muens

๐Ÿ’ป

Toxuin

๐Ÿ’ป

Scott Rippee

๐Ÿ’ป

Yi Ai

๐Ÿ’ป

markvp

๐Ÿ’ป

Alex

๐Ÿ’ป

Alex Jurkiewicz

๐Ÿ’ป

Anas Qaderi

๐Ÿ’ป

Andreas Heissenberger

๐Ÿ’ป

mickael

๐Ÿ’ป

Brian Torres-Gil

๐Ÿ’ป

Cameron Childress

๐Ÿ’ป

Chris Chiang

๐Ÿ’ป

Esref Durna

๐Ÿ’ป

Hari

๐Ÿ’ป

Ivan Barlog

๐Ÿ’ป

John Veldboom

๐Ÿ’ป

Luca Bigon

๐Ÿ’ป

Lucas

๐Ÿ’ป

Mark Pollmann

๐Ÿ’ป

Maurice Williams

๐Ÿ’ป

Mike Chen

๐Ÿ’ป

asnaseer-resilient

๐Ÿ’ป

Neal Clark

๐Ÿ’ป

Nicky Moelholm

๐Ÿ’ป

Patrick Arminio

๐Ÿ’ป

Paul Li

๐Ÿ’ป

James Lal

๐Ÿ’ป

Sam Gilman

๐Ÿ’ป

Stefan Ceriu

๐Ÿ’ป

tsmith

๐Ÿ’ป

veloware

๐Ÿ’ป

Vladimir Lebedev

๐Ÿ’ป

Ryan Jones

๐Ÿ’ป

Vicary A.

๐Ÿ’ป

Brian Santarelli

๐Ÿค”

Emilio Font

๐Ÿ’ป

Andriy Nastyn

๐Ÿ’ป ๐Ÿ“–

MarcusJones

๐Ÿ“–

h-kishi

๐Ÿ’ป

Dillon Browne

๐Ÿ’ป

Piotr Grzesik

๐Ÿ’ป

Aleksa Cukovic

๐Ÿ’ป

Scott Davey

๐Ÿ’ป

Mateus Holzschuh

๐Ÿ’ป

This project follows the all-contributors specification. Contributions of any kind welcome!

About

serverless plugin for appsync

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 99.8%
  • JavaScript 0.2%