diff --git a/README.md b/README.md new file mode 100644 index 0000000..f0e93b9 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# MyWonderfulTirelessAPI +A tireless API, because being restful is just overdone. + +## Service endpoints: + +- **GET** /students - returns a list of all students +- **GET** /students?search= - returns a list of students filtered on name matching the given query +- **GET** /students/:studentId - returns details of a specific student by student id +- **GET** /grades/:studentId - returns all grades for a given student by student id +- **POST** /grades - records a new grade, returns success status in JSON response (meaning you do not need to actually store the grade in a database. You do need to validate that the user supplied at least a grade, and a studentId) +- **POST** /register - creates a new user, returns success status in JSON response (meaning you do not need to actually store the user info in a database. You do need to validate that the user supplied username and email)