Giter Site home page Giter Site logo

13-express-mongo's Introduction

CF 13: Single Resource Mongo and Express API

Submission Instructions

  • fork this repository & create a new branch for your work
  • write all of your code in a directory named lab- + <your name> e.g. lab-susan
  • push to your repository
  • submit a pull request to this repository
  • submit a link to your PR in canvas
  • write a question and observation on canvas

Learning Objectives

  • students will be able to work with the MongoDB database management system
  • students will understand the primary concepts of working with a NoSQL database management system
  • students will be able to create custom data models (schemas) through the use of mongoose.js
  • students will be able to use mongoose.js helper methods for interacting with their database persistence layer

Requirements

Configuration

  • package.json
  • .eslintrc.json
  • .gitignore
  • README.md
    • your README.md should include detailed instructions on how to use your API

Feature Tasks

  • create an HTTP Server using express
  • create a resource model of your choice that uses mongoose.Schema and mongoose.model
  • use the body-parser express middleware to parse the req body on POST and PUT requests
  • use the npm debug module to log the functions and methods that are being used in your application
  • use the express Router to create a route for doing RESTFUL CRUD operations against your model

Server Endpoints

/api/resource-name

  • POST request
    • should pass data as stringifed JSON in the body of a post request to create a new resource

/api/resource-name/:id

  • GET request
    • should pass the id of a resource through the url endpoint to get a resource
      • this should use req.params, not querystring parameters
  • PUT request
    • should pass data as stringifed JSON in the body of a put request to update a pre-existing resource
  • DELETE request
    • should pass the id of a resource though the url endpoint to delete a resource
      • this should use req.params

Tests

  • create a test that will ensure that your API returns a status code of 404 for routes that have not been registered
  • create a series of tests to ensure that your /api/resource-name endpoint responds as described for each condition below:
    • GET - test 200, returns a resource with a valid body
  • GET - test 404, respond with 'not found' for valid requests made with an id that was not found
  • PUT - test 200, returns a resource with an updated body
  • PUT - test 400, responds with 'bad request' if no request body was provided
  • PUT - test 404, responds with 'not found' for valid requests made with an id that was not found
  • POST - test 400, responds with 'bad request' if no request body was provided
  • POST - test 200, returns a resource for requests made with a valid body

Bonus

  • 2pts: a GET request to /api/resource-name should return an array of stored resources

13-express-mongo's People

Contributors

gavinthomas1192 avatar arn1313 avatar agrampa avatar iwalker17 avatar mscharlock avatar zaj6827 avatar sjschmidt44 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.