Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cubonetwork/serverless-graphql-rest-api
The porpuse of this repo is to create a REST API using GraphQL (Apollo Server) and Serverless framework.
https://github.com/cubonetwork/serverless-graphql-rest-api
apollo-server graphql lambda neo4j neptune serverless serverless-framework
Last synced: about 2 months ago
JSON representation
The porpuse of this repo is to create a REST API using GraphQL (Apollo Server) and Serverless framework.
- Host: GitHub
- URL: https://github.com/cubonetwork/serverless-graphql-rest-api
- Owner: cubonetwork
- Created: 2018-04-18T19:24:56.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-22T09:23:45.000Z (about 2 years ago)
- Last Synced: 2023-03-01T21:05:48.930Z (almost 2 years ago)
- Topics: apollo-server, graphql, lambda, neo4j, neptune, serverless, serverless-framework
- Language: JavaScript
- Size: 3.45 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
serverless-graphql-rest-api
===========================
The main porpuse of this repo is be a sample of how to integrate Apollo Server + GraphQL + Serverless Architecture. For this we have created a search API thought a schema like following:
To summarize we have 3 entities: User, Company and Contacts. So, if I wish retrieve all the contacts of a specific company, how could I do it? This question will be answered by this code.
# Dependencies
* [Serverless framework](https://serverless.com)
* [serverless-offline](https://github.com/dherault/serverless-offline)
* [serverless-dynamodb-local](https://github.com/99xt/serverless-dynamodb-local)
* [Apollo Server - Lambda](https://www.apollographql.com/docs/apollo-server/servers/lambda.html)
To understand the concepts and code implemented in this repo it's necessary a basic knowledge of GraphQL, Serverless Architecture and Node.js programming language.
# Running
After clone this repo in your computer, go to project folder and install dependencies using the following command:
```bash
npm i
```
After all dependencies have installed you can run the project throught the command:
```bash
npm run offline
```
If everything was fine you could see a screen like this:
# Implementation
This implementation was based on the post [Running a scalable & reliable GraphQL endpoint with Serverless](https://serverless.com/blog/running-scalable-reliable-graphql-endpoint-with-serverless/).
Basically, the project contains two handlers, as you can see at [serverless.yml](./serverless.yml) file:
* `graphql`: whose implementation is in [src/handler.js](./src/handler.js) file, more specifically at line 11. This handler is responsible to process requests throught GraphQL using apollo-server-lambda implementation. In other words is the Backend API of our project.
* `graphiql`: whose implementation is in [src/handler.js](./src/handler.js) file, more specifically at line 25. This handler returns a GraphQL Client implementation called graphiql. Where you can write your queries and see the results.
Other important files are:
* [graphql](./src/graphql/): The graphql folder contains the graphql schema used for this project. In this folder you will find all schema's types, resolvers and queries.
* [schema.js](./src/graphql/schema.js): Where we define the GraphQL types, queries, mutations and subscriptions, which makes up the GraphQL Schema.
* [resolvers.js](./src/graphql/resolvers.js): The implementation of GraphQL resolvers based on types and queries defined at `schema.js`.
* [types.js](./src/graphql/types.js): Just an array of types which will by used at `schema.js`.
* [src/core](./src/core/): The core folder contains the code to integrate with data layer. We have used DynamoDB to persist data.
* [dynamodb/seed-data](./dynamodb/seed-data/): The seed-data folder contains sample data used on offline mode. See `serverless-dynamodb-local` for more information.
# See it in action
Just open the link `http://localhost:3000/graphiql` in your browser.
# Next steps
* Compares [Apollo Engine](https://www.apollographql.com/docs/engine/setup-lambda.html) and [AppSync](https://hackernoon.com/running-a-scalable-reliable-graphql-endpoint-with-serverless-24c3bb5acb43) to manage cache and metrics about the GraphQL API
* Reimplement this project using some GraphDB
* Amazon Neptune: until now (04/19/2018) neptune is only available for whitelisted users and there is no integration from Lambda functions. To request a preview for Neptune [click here](https://pages.awscloud.com/NeptunePreview.html).
* Neo4j: It's a good option, but, AWS there is no a managed service for neo4j. So you have to install and mantain it in a EC2 instance.
## Neo4j
To run neo4j using docker run the following command:
```bash
npm run neo4j:start
```
### Not implemented yet
* [neo4j/seed-data.js](./neo4j/seed-data.js): the porpuse of this file is to create data on neo4j docker instance.
# Test
We are using [jest](https://facebook.github.io/jest/docs/en/getting-started.html) for testing.
## Running tests
```bash
npm run test
```
## Coverage
```bash
npm run coverage
```
# Documentation
```bash
npm run generate-docs
```
After see generated site in [./docs/index.html](./docs/index.html).
# Deploy
First of all you need to configure your AWS credentials:
```bash
sls config credentials --provider aws --key --secret
```
After that:
```bash
npm run deploy
```
# About