You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
12 lines
887 B
12 lines
887 B
5 years ago
|
# MyWonderfulTirelessAPI
|
||
|
|
A tireless API, because being restful is just overdone.
|
||
|
|
|
||
|
|
## Service endpoints:
|
||
|
|
|
||
|
|
- **GET** /students - returns a list of all students
|
||
|
|
- **GET** /students?search=<query> - 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)
|