Git Product home page Git Product logo

11-express-server's Introduction

cf Lab 11: Express and Mongo REST API

Submission Instructions

  • Work in a fork of this repository
  • Work in a branch on your fork
  • Write all of your code in a directory named lab- + <your name> e.g. lab-susan
  • Open a pull request to this repository
  • Submit on canvas a question and observation, how long you spent, and a link to your pull request

Resources

Configuration

Configure the root of your repository with the following files and directories. Thoughfully name and organize any aditional configuration or module files.

  • README.md - contains documentation
  • .env - contains env variables (should be git ignored)
  • .gitignore - contains a robust .gitignore file
  • .eslintrc - contains the course linter configuratoin
  • .eslintignore - contains the course linter ignore configuration
  • package.json - contains npm package config
    • create a lint script for running eslint
    • create a test script for running tests
    • create a start script for running your server
    • create dbon and dboff scripts for managing the mongo daemon
  • db/ - contains mongodb files (should be git ignored)
  • lib/ - contains module definitions
  • model/ - contains module definitions
  • route/ - contains module definitions
  • __test__/ - contains test modules

Feature Tasks

For this assignment you will be building a RESTful HTTP server useing express.

Model

In the model/ directory create a Model for a resource using Mongoose (that is different from the class lecture resource). The model must include 4 properties, two of which should be required.

Server Endpoints

Create the following routes for performing CRUD opperations on your resourcee

  • POST /api/<resource-name>
    • pass data as stringifed JSON in the body of a POST request to create a new resource
    • on success respond with a 200 status code and the created note
    • on failure due to a bad request send a 400 status code
  • GET /api/<resource-name> and GET /api/<resource-name>/:id
    • with no id in the query string it should respond with an array of all of your resources
    • with an id in the query string it should respond with the details of a specifc resource (as JSON)
      • if the id is not found respond with a 404
  • DELETE /api/<resource-name>/:id
    • the route should delete a note with the given id
    • on success this should return a 204 status code with no content in the body
    • on failure due to lack of id in the query respond with a 400 status code
    • on failure due to a resouce with that id not existing respond with a 404 status code

Tests

  • Write tests to ensure the /api/resource-name endpoint responds as described for each condition below:
    • GET: test 404, it should respond with 'not found' for valid requests made with an id that was not found
    • GET: test 200, it should contain a response body for a request made with a valid id
    • POST: test 400, it should respond with 'bad request' if no request body was provided or the body was invalid
    • POST: test 200, it should respond with the body content for a post request with a valid body

Documentation

In the README.md write documention for starting your server and makeing requests to each endpoint it provides. The documentaion should describe how the server would respond to valid and invalid requests.

Bonus 1pt

  • Create and test a put route

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.