serverless-plugin-graphiql

Runs a local http server for graphiql and your graphql handler

Build Status Coverage Status serverless Npm Version

Usage

See /example directory for how easily it's done!

Steps

  1. Create a lambda function named graphql that implements a graphql server
  2. Add serverless-plugin-graphiql to serverless plugins array
  3. Run sls graphiql command from root of serverless project
  4. Visit localhost:8000/graphql in your browser to use graphiql

About

  • This plugin creates two http endpoints:
GET /graphql
POST /graphql
  • Once graphiql is running, you can also make requests via cli:
curl -X POST \
-H "Content-Type: application/json" \
-d '{"query": "{ hello }"}' \
localhost:8000/graphql

Options

--function -f   function name in serverless.yml for graphql handler, Default: graphql
--port -p       port for local http server to listen on, Default: 8000

Requirements

  • Node.js > v6.0