sigonasr2/MyWonderfulTirelessAPI
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Create README.md

Browse Source
This commit is contained in:
sigonasr2 2020-06-23 04:51:06 +09:00 committed by GitHub
parent 8444b7d041
commit ce5e82e437
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md Normal file
View File

@ -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=<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)