zaj6827 / 08-vanilla-rest-api

Lab 08: Vanilla REST 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 learn to use promise constructs to manage asynchronous code
• students will learn to create a vanilla RESTful API with in-memory persistence

Requirements

Configuration

• .gitignore
• .eslintrc.json
• .eslintignore
• package.json
• README.md

Feature Tasks

• documentation:
  • write a paragraph about what your API does
  • document any resources that helped you complete you assignment
  • define how another dev can 'get started' with your api on their own
  • document each of the available endpoints; including example request/response formats for each
• create the following directories to organize your code:
  • lib
  • model
  • route
  • __test__
• create an HTTP server using the native NodeJS http module
• create an object constructor that creates a simple resource with at least 3 properties
  • include an _id property that is set to a unique id (hint: you'll need to use uuid)
  • include two additional properties of your choice (ex: name, content, etc.)
• create a custom body parser module that uses promises to parse the JSON body of POST and PUT requests
• create a custom url parser module that returns a promise and uses the NodeJS url and querystring modules to parse the request url
• create a router constructor that handles requests to GET, POST, PUT, and DELETE requests
• create a storage module that will store resources by their schema type (ex: note) and id

Tests make an attempt at TDD today!!

• write a test to ensure that your api returns a status code of 404 for routes that have not been registered
• write tests to ensure the /api/simple-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 400, it should respond with 'bad request' if no id was provided in the request
• note: this will need to change if you complete the bonus point
• 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 201, it should respond with the body content for a post request with a valid body
• PUT: test 400, it should respond with 'bad request' if no request body was provided or the body was invalid
• PUT: test 204, it should respond with no body content for a put request with a valid body
• DELETE: test 400, it should respond with 'bad request' if no resource id was provided
• DELETE: test 404, it should respond with 'not found' for valid requests made with an id that was not found
• DELETE: test 204, it should respond with no body content for a request request with a valid resource id

Server Endpoints

/api/simple-resource-name

• POST request
• pass data as stringifed JSON in the body of a POST request to create a new resource
• successful status code of 201
• PUT request
• pass data as stringifed JSON in the body of a PUT request to update an existing resource
• if that resource does not exist, create it
• successful status code of 204
• GET request
• pass ?id=<uuid> as a query string parameter to retrieve a specific resource (as JSON)
• successful status code of 200
• DELETE request
• pass ?id=<uuid> in the query string to DELETE a specific resource
• successful status code of 204

Rubric: 10pts

• 2pts: Documentation
• 5pts: Feature Tasks
• 3pts: Tests

Bonus

• 1pt: write as many unit tests as you can to cover all of the modularized code in our lib, model, and route dirs
  • reminder: test coverage standards are 80% or better in the industry
• 1pt: a GET request to /api/simple-resource-name with no ?id= should return an array of all of the ids for that resource, and associated tests