GraphQl-MongongoDB-Express-Nodejs

Nodejs—>GraphQL + Express + MongoDB

A small project to illustrate using GraphQL with MongoDB in Express as simply as possible
Project Goals:

Create a Nodejs GraphQL + MongoDB + Express project that is as simple as possible
GraphiQL Integration to send Queries / Mutations
Ability to use Postman and Http Requestor or other REST Client to POST GraphQL Queries / Mutations
Use of ES6 (but minimally)-Babel interprates ES6
Full Create, Update and Query from GraphQL to MongoDB
Installation

ES6 / Node V4+

This project makes use of ES6 which requires a 4+ version of Node https://nodejs.org/en/download/

MongoDB

In order to run this project you need to install MongoDB and ensure an instance is running. https://www.npmjs.com/package/mongodb

npm install mongodb --save

To see the data you are saving you can use a MongoDB Manager App such as https://robomongo.org/

NPM Modules

The following NPM modules are required in package.json:

express
express-graphql
graphql
mongoose
babel-cli
babel-preset-es2015
nodemon

Install with:

npm install
Run the project

Running in Development

npm dev is configured with nodmon so that the server automatically restarts when code files are changes

npm run dev
Running in Production

npm start
npm prestart will run first, transpile the ES6 code and save to dist folder. npm start will then run the code directly from the dist folder

CLI Commands

Running GraphQL Mutations & Queries

You can run these queries / mutations within GraphiQL, alternatively you can run them within a tool such as Postman. To do so ensure you POST the query / mutation in the body and set the content-type to GraphQL.

Create a user
<<<<<<< HEAD

=======

mutation {
  addUser( name:"Danstan Otieno Onyango",address:"24 Street Nairobi",age:"28", email:"[email protected]", tel:"(+254) 7228888") {
    id,
    name,
    email,
    address
    tel,
    age
  }
}

Response

{
  "data": {
    "addUser": {
      "id": "5911ad4cfdf06e07e4841f6b",
      "name": "Danstan Otieno Onyango",
      "email": "[email protected]",
      "address": "24 Street Nairobi",
      "tel": "(+254) 7228888",
      "age": "28"
    }
  }
}

523d194194c59dc6c80478fcc80b9cd836629a4c
Find a user

Find the first user in the MongoDB, requesting just the name and email address

query {
  userId(id:"5911adb3fdf06e07e4841f6d") {
    id,
    name,
    email,
    address
    tel,
    age
  }
}

Response

{
  "data": {
    "userId": {
      "id": "5911adb3fdf06e07e4841f6d",
      "name": "Danstan Otieno Onyango",
      "email": "[email protected]",
      "address": "24 Street Nairobi",
      "tel": "(+254) 7228888",
      "age": "28"
    }
  }
}

Show all users

query {
  users {
    id,
    name,
    address,
    email,
    age,
  }
}

Response

{
  "data": {
    "users": [
      {
        "id": "5911acb8fdf06e07e4841f65",
        "name": "Danstan Otieno Onyango",
        "address": "24 Street Nairobi",
        "email": "[email protected]",
        "age": "28"
      },
      {
        "id": "5911ad15fdf06e07e4841f67",
        "name": "Danstan Otieno Onyango",
        "address": "24 Street Nairobi",
        "email": "[email protected]",
        "age": "28"
      },
      {
        "id": "5911ad3cfdf06e07e4841f69",
        "name": "Danstan Otieno Onyango",
        "address": "24 Street Nairobi",
        "email": "[email protected]",
        "age": "28"
      },
      {
        "id": "5911ad4cfdf06e07e4841f6b",
        "name": "Danstan Otieno Onyango",
        "address": "24 Street Nairobi",
        "email": "[email protected]",
        "age": "28"
      },
      {
        "id": "5911adb3fdf06e07e4841f6d",
        "name": "Danstan Otieno Onyango",
        "address": "24 Street Nairobi",
        "email": "[email protected]",
        "age": "28"
      }
    ]
  }
}

Update a user

mutation {
  updateUser(id:"5911b5cdfdf06e07e4841fe8", name:"Danstan Otieno Onyango",address:"24 Street Nairobi",age:"30", email:"[email protected]", tel:"(+254) 7228888") {
    id
  }
}

GraphQL Resolvers

GraphQL doesn’t care where your data is stored, in this case it’s in a MongoDB.

userSchema.js uses a Mongoose Schemea and configures a number of exported functions for our GraphQL Resolvers to work with in order to load a user / list of users or create and update a user.

GraphQL Schema

userType.js creates a GraphQLObjectType describing the structure of our data model.

userMutations.js and userQueries.js specify the operations available from GraphQL and link to our resolvers, in this case Mongoose operations that return a promise.