annaul / 08-vanilla_rest_api

Lab 08 - Vanilla REST API

Lab 08: In-Memory Resource API

To Submit this Assignment

• fork this repository
• write all of your code in a directory named lab- + <your name> e.g. lab-brian
• 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

Include

• .gitignore
• .eslintrc
• package.json
• gulpfile.js
• README.md

Description

• Create the following directories to organize your code:
  • lib
  • model
  • 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 node-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

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
• GET request
• pass ?id=<uuid> as a query string parameter to retrieve a specific resource (as JSON)
• DELETE request
• pass ?id=<uuid> in the query string to DELETE a specific resource
• this should return a 204 status code with no content in the body

Tests

• 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
• 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

Bonus

• 2pts: a GET request to /api/simple-resource-name with no ?id= should return an array of all of the ids for that resource