martin-ngigi / laravel_mysql_crud_api

Laravel api to perfom CRUD operations.

CRUD API

Installations:

1. Install Xamp(once) - will also automatically install php
2. Install Composer(once)
3. Install laravel(once)
4. Install Tabine AI autocompletion extension in VS

• Check php version:

	php -v

• Check composer version:

	composer --version

• Install laravel globally in cmd by running following command in cmd:

	composer global require laravel/installer

• check laravel version:

	laravel -v

Create new Laravel project:

	laravel new laravel_mysql_crud_api

start Laravel's local development server using the Laravel's Artisan CLI serve command:

	cd laravel_mysql_crud_api
	php artisan serve

then web will be visible at: ``` http://127.0.0.1:8000/ ```
- create a student model ``` php artisan make:model Student ``` - or [MOST PREFERRED METHOD] - create a student model and a migration ``` php artisan make:model Student -m ```
- Making Controller run: ``` php artisan make:controller StudentController ``` - or - Making Controller with api methods run: ............. "--api" will create associated methods in api such as create, update, delete ``` php artisan make:controller StudentController --api ``` Checking all routes: to check all routes, run in cmd: ``` php artisan route:list ``` Migrate: ``` php artisan migrate ``` 1. POST -> Create student: - endpoint -> http://127.0.0.1:8000/api/create/create - body ``` { "name": "Martin", "age": 22 } ```

• result

{
    "code": 201,
    "success": true,
    "timestamp": "2023-03-03T07:20:10.504825Z",
    "data": {
        "name": "Simon",
        "age": 14,
        "updated_at": "2023-03-03T07:20:10.000000Z",
        "created_at": "2023-03-03T07:20:10.000000Z",
        "id": 4
    }
}

2. GET -> get all students:

• endpoint -> http://127.0.0.1:8000/api/all
• response:

{
    "code": 200,
    "success": true,
    "timestamp": "2023-03-03T07:19:51.837206Z",
    "data": [
        {
            "id": 1,
            "created_at": "2023-03-02T08:10:01.000000Z",
            "updated_at": "2023-03-03T07:19:42.000000Z",
            "name": "Martin Wainaina",
            "age": 23
        },
        {
            "id": 3,
            "created_at": "2023-03-03T04:30:14.000000Z",
            "updated_at": "2023-03-03T04:30:14.000000Z",
            "name": "David",
            "age": 54
        }
    ]
}

3. GET -> get one student by id:

• endpoint -> http://127.0.0.1:8000/api/all/1
• response :

{
    "code": 200,
    "success": true,
    "timestamp": "2023-03-03T07:19:21.541273Z",
    "data": {
        "id": 1,
        "created_at": "2023-03-02T08:10:01.000000Z",
        "updated_at": "2023-03-02T08:44:24.000000Z",
        "name": "Martin 1",
        "age": 24
    }
}

4. PUT -> Update student by id

• endpoint-> http://127.0.0.1:8000/api/update/1
• body

{
    "name": "Martin 1",
    "age": 24
}

• reponse

{
    "code": 200,
    "success": true,
    "timestamp": "2023-03-03T07:19:42.541503Z",
    "data": {
        "id": 1,
        "created_at": "2023-03-02T08:10:01.000000Z",
        "updated_at": "2023-03-03T07:19:42.000000Z",
        "name": "Martin Wainaina",
        "age": 23
    }
}

5. DELETE - > delete student by id

• endpoint -> http://127.0.0.1:8000/api/delete/4
• response

{
    "code": 200,
    "success": true,
    "timestamp": "2023-03-03T07:20:20.901837Z",
    "data": 1
}