Giter VIP home page Giter VIP logo

11-single_resource_express_api's Introduction

CF Lab 11: Single Resource Express 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

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

Description

  • Create an HTTP server using express
  • Create a object constructor that creates a simple resource with at least 3 properties
    • it can not have the same properties as the in-class sample code (other than the id)
    • a unique id property should be included (node-uuid)
    • include two additional properties of your choice
  • Use the JSON parser included with the body-parser module as a middleware component to parse the request body on POST and PUT routes
  • Use the npm debug module to log the methods in your application
  • Create an npm script to automate the debug process and start the server
  • Persist your API data using the storage module and file system persistence

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

11-single_resource_express_api's People

Contributors

bnates avatar

Watchers

 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.