CS471: Web and Mobile Development - RESTful Services (100 Points)
Assignment Goals
The goals of this assignment are:- To implement a web service in node.js using express and mongoose
The Assignment
If (and only if) you are using GitHub to submit, you can clone this assignment from GitHub Classroom at https://classroom.github.com/a/8DnXHFfM. Otherwise, you may skip this step!In this assignment, you will design a RESTful service interface and implement it using node.js. You will test your service with a client that you will implement in node.js or in a web browser using JavaScript.
Part 1: Stakeholder-Based Design
Choose a partner with whom you will discuss your model interface. Your RESTful endpoints and data types should be well-established here. Please document the results of this discussion and your overall design in your README. I should be able to deploy and use your service by just reading your design document in the README.
Prior to proceeding, notify the instructor of the general service that you plan to implement, and the design and interface you plan to utilize.
Part 2: Service Implementation
Craete your model, routes, and express service in node.js, according to the design you determined with your partner.
Part 3: Service Client
Develop a service client in node.js or a browser webpage to invoke each operation of your service.
Part 4: Presentation
Make a Screencast in which you demonstrate your program, and also review your codebase. Imagine you are explaining how to use these API’s to a new web service developer. Give them a thorough tour! I hope to solicit volunteers to demo their programs to the class!
Submission
In your submission, please include answers to any questions asked on the assignment page in your README file. If you wrote code as part of this assignment, please describe your design, approach, and implementation in your README file as well. Finally, include answers to the following questions:- Describe what you did, how you did it, what challenges you encountered, and how you solved them.
- Please answer any questions found throughout the narrative of this assignment.
- If collaboration with a buddy was permitted, did you work with a buddy on this assignment? If so, who? If not, do you certify that this submission represents your own original work?
- Please identify any and all portions of your submission that were not originally written by you (for example, code originally written by your buddy, or anything taken or adapted from a non-classroom resource). It is always OK to use your textbook and instructor notes; however, you are certifying that any portions not designated as coming from an outside person or source are your own original work.
- Approximately how many hours it took you to finish this assignment (I will not judge you for this at all...I am simply using it to gauge if the assignments are too easy or hard)?
- Your overall impression of the assignment. Did you love it, hate it, or were you neutral? One word answers are fine, but if you have any suggestions for the future let me know.
- Using the grading specifications on this page, discuss briefly the grade you would give yourself and why. Discuss each item in the grading specification.
- Any other concerns that you have. For instance, if you have a bug that you were unable to solve but you made progress, write that here. The more you articulate the problem the more partial credit you will receive (it is fine to leave this blank).
Assignment Rubric
| Description | Pre-Emerging (< 50%) | Beginning (50%) | Progressing (85%) | Proficient (100%) |
|---|---|---|---|---|
| Algorithm Implementation (40%) | The algorithm fails on the test inputs due to major issues, or the program fails to compile and/or run | The algorithm fails on the test inputs due to one or more minor issues | The algorithm is implemented to solve the problem correctly according to given test inputs, but would fail if executed in a general case due to a minor issue or omission in the algorithm design or implementation | A reasonable algorithm is implemented to solve the problem which correctly solves the problem according to the given test inputs, and would be reasonably expected to solve the problem in the general case |
| Code Quality and Documentation (30%) | Code commenting and structure are absent, or code structure departs significantly from best practice, and/or the code departs significantly from the style guide | Code commenting and structure is limited in ways that reduce the readability of the program, and/or there are minor departures from the style guide | Code documentation is present that re-states the explicit code definitions, and/or code is written that mostly adheres to the style guide | Code is documented at non-trivial points in a manner that enhances the readability of the program, and code is written according to the style guide |
| Service Endpoint Interface Design (20%) | Improper service endpoints are given, or use verbs instead of a CRUD model | An arbitrary mapping of service endpoints is given to HTTP verbs (for example, only GET or POST verbs are used) | Some service endpoints are ambiguous or improperly mapped | Service endpoints are thoroughly defined for the application chosen, with CRUD endpoints that represent nouns that are appropriately mapped to HTTP verbs |
| Writeup and Submission (10%) | An incomplete submission is provided | The program is submitted, but not according to the directions in one or more ways (for example, because it is lacking a readme writeup) | The program is submitted according to the directions with a minor omission or correction needed, and with at least superficial responses to the bolded questions throughout | The program is submitted according to the directions, including a readme writeup describing the solution, and thoughtful answers to the bolded questions throughout |
Please refer to the Style Guide for code quality examples and guidelines.