Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sid88in/serverless-appsync-plugin

serverless plugin for appsync
https://github.com/sid88in/serverless-appsync-plugin

aws-appsync dynamodb elasticsearch graphql lambda serverless-applications serverless-framework serverless-plugin

Last synced: 2 months ago
JSON representation

serverless plugin for appsync

Host: GitHub
URL: https://github.com/sid88in/serverless-appsync-plugin
Owner: sid88in
License: mit
Created: 2017-12-28T09:00:02.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2024-10-17T06:43:39.000Z (3 months ago)
Last Synced: 2024-10-19T09:17:55.877Z (3 months ago)
Topics: aws-appsync, dynamodb, elasticsearch, graphql, lambda, serverless-applications, serverless-framework, serverless-plugin
Language: TypeScript
Size: 2.77 MB
Stars: 950
Watchers: 20
Forks: 188
Open Issues: 130
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

popular-dependents-lists - sid88in/serverless-appsync-plugin - 🌟 900 (Ramda / sid88in/serverless-appsync-plugin)

README

        [![Tests](https://github.com/sid88in/serverless-appsync-plugin/workflows/Tests/badge.svg)](https://github.com/sid88in/serverless-appsync-plugin/actions?query=workflow%3ATests) 

[![All Contributors](https://img.shields.io/badge/all_contributors-69-orange.svg?style=flat-square)](#contributors-)

Deploy [AppSync](https://aws.amazon.com/appsync) API's in minutes using this [Serverless](https://www.serverless.com/) plugin.

# Minimum requirements

- [Node.js v16 or higher](https://nodejs.org)

- [Serverless v3.0.0 or higher](https://github.com/serverless/serverless)

# Installation

```

npm install serverless-appsync-plugin

```

# Quick start

```yaml

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

- [General config](doc/general-config.md)

- [DataSources](doc/dataSources.md)

- [Resolvers](doc/resolvers.md)

- [Pipeline Functions](doc/pipeline-functions.md)

- [Authentication](doc/authentication.md)

- [API keys](doc/API-keys.md)

- [Custom Domain](doc/custom-domain.md)

- [Variable Substitutions](doc/substitutions.md)

- [Caching](doc/caching.md)

- [Web Application Firewall (WAF)](doc/WAF.md)

# CLI

This plugin adds some useful CLI commands. See [CLI commands documentation](doc/commands.md)

# 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:

```yaml

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](https://github.com/sid88in/serverless-appsync-plugin/tree/v1) of this plugin, [follow this guide](doc/upgrading-from-v1.md)

# Contributing

If you have any questions, issue, feature request, please feel free to [open an issue](/issues/new).

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

# Resources

## Tools

- [Mapping Tool](https://mappingtool.dev/): Quickly Build and Debug AppSync & API Gateway Mapping Templates

- [GraphBolt](http://graphbolt.dev/?utm_source=serverless-appsync-plugin&utm_medium=Referral): A professional desktop app solution for building, testing, and debugging AppSync APIs.

- [AppSync Resolver Autocomplete](https://marketplace.visualstudio.com/items?itemName=theBenForce.appsync-resolver-autocomplete): VSCode extension. Autocomplete support for VTL template files.

## Video tutorials

- [Building an AppSync + Serverless Framework Backend | FooBar](https://www.youtube.com/watch?v=eTUYqI_LCQ4)

## Blog tutorial

- _Part 1:_ [Running a scalable & reliable GraphQL endpoint with Serverless](https://serverless.com/blog/running-scalable-reliable-graphql-endpoint-with-serverless/)

- _Part 2:_ [AppSync Backend: AWS Managed GraphQL Service](https://medium.com/@sid88in/running-a-scalable-reliable-graphql-endpoint-with-serverless-24c3bb5acb43)

- _Part 3:_ [AppSync Frontend: AWS Managed GraphQL Service](https://hackernoon.com/running-a-scalable-reliable-graphql-endpoint-with-serverless-db16e42dc266)

- _Part 4:_ [Serverless AppSync Plugin: Top 10 New Features](https://medium.com/hackernoon/serverless-appsync-plugin-top-10-new-features-3faaf6789480)

# Contributors ✨

Thanks goes to these wonderful people :clap:

  

    
_{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](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!