To use this API you need a running instance of Apache and MySQL. You can use XAMPP for example.
To use with XAMPP:
- Clone this repository into your htdocs folder
- Make sure you don't have a database named
users_parcelsin your MySQL instance (if you do, delete it) or change the name of the database in theconfig.phpfile
To make requests to the API, you can use a number of things, for example Postman and import the collections from the Postman folder.
Returns all users in the database:
[
{
"id": 1,
"first_name": "Zsombor",
"last_name": "Balogh",
"email_address": "[email protected]",
"phone_number": null
},
{
"id": 3,
"first_name": "Jenő",
"last_name": "Polgár",
"email_address": "[email protected]",
"phone_number": "+36203114566"
},
{
"id": 4,
"first_name": "Mátyás",
"last_name": "Király",
"email_address": "[email protected]",
"phone_number": null
}
]Adds a new user to the database. The request body should look like this:
{
"first_name": "Kázmér",
"last_name": "Kovács",
"email_address": "[email protected]",
"password": "Porcica01",
"phone_number": "+36302131886"
}The response will look like this:
{
"id": 6,
"first_name": "Kázmér",
"last_name": "Kovács",
"email_address": "[email protected]",
"phone_number": "+36302131886"
}Returns the parcel with the given parcel number
{
"id": 1,
"parcel_number": "850f6335d7",
"size": "M",
"user": {
"id": 3,
"first_name": "Jenő",
"last_name": "Polgár",
"email_address": "[email protected]",
"phone_number": "+36203114566"
}
}Adds a new parcel to the database. The request body should look like this:
{
"size": "L",
"user_id": 1
}The response will look like this:
{
"parcel_number": "679cfadf3a",
"size": "L",
"user": {
"id": 1,
"first_name": "Zsombor",
"last_name": "Balogh",
"email_address": "[email protected]",
"phone_number": null
}
}