search

survivorbat / Studentmeals-node-exam

School project nodejs server that provides an API
0 stars 2 forks source link

readme

prog4node

Table of Contents

prog4node

## Details authentication token Requirements - Login details (studentNumber and password). - Postman ### Requesting token | Field | Value | | ----------- | ------------------------------------------------------------ | | Method | POST | | Request URL | https://prog4node.herokuapp.com/api/login | | Headers | Key:Content-Type Value:application/x-www-form-urlencoded | | Body | Key:studentNumber value:NUMMERIC, Key:password value:VALUE | ### Using this API | Field | Value | | ----------- | ------------------------------------------------------------ | | Method | GET | | Request URL | https://prog4node.herokuapp.com/api/student | | Headers | Key:Content-Type Value:application/x-www-form-urlencoded | | Body | Key:Authorization Value:Bearer AUTHTOKEN | ## Details student API This is the endpoint that concerns the students in the database. ### Using this API The following endpoints are available: | Field | Value | | ----------- | ------------------------------------------------------------ | | Method | GET | | Request URL | https://prog4node.herokuapp.com/api/student | | Headers | Key:Authorization Value:Bearer AUTHTOKEN | | Body | | | Field | Value | | ----------- | ------------------------------------------------------------ | | Method | POST | | Request URL | https://prog4node.herokuapp.com/api/student | | Headers | | | Body | | | Field | Value | | ----------- | ------------------------------------------------------------ | | Method | DELETE | | Request URL | https://prog4node.herokuapp.com/api/student/:id | | Headers | Key:Authorization Value:Bearer AUTHTOKEN | | Body | | | Field | Value | | ----------- | ------------------------------------------------------------ | | Method | PUT | | Request URL | https://prog4node.herokuapp.com/api/student | | Headers | Key:Authorization Value:Bearer AUTHTOKEN | | Body | | | Field | Value | | ----------- | ------------------------------------------------------------ | | Method | GET | | Request URL | https://prog4node.herokuapp.com/api/student/:id | | Headers | Key:Authorization Value:Bearer AUTHTOKEN | | Body | | | Field | Value | | ----------- | ------------------------------------------------------------ | | Method | GET | | Request URL | https://prog4node.herokuapp.com/api/student/:id/picture | | Headers | Key:Authorization Value:Bearer AUTHTOKEN | | Body | | ## Details fellow eaters API TODO ### Using this API TODO | Field | Value | | ----------- | ------------------------------------------------------------ | | Method | GET | | Request URL | https://prog4node.herokuapp.com/api/felloweater | | Headers | Key:Content-Type Value:application/x-www-form-urlencoded | | Body | Key:ID Value:NUMMERIC | ## Details meals API TODO ### Using this API TODO | Field | Value | | ----------- | ------------------------------------------------------------ | | Method | | | Request URL | | | Headers | | | Body | | Enjoy!