Laravel Backend Starter

Backend laravel with json web token and Cloudinary

Authors

• Follow Me @fajar-dev

Give a star if you like this repository

Tech Stack

Package: JWT, cloudinary,

Server: Laravel 10

Requirements

• git
• PHP 8
• laravel
• A browser (e.g., Firefox or Chrome)
• composser
• SQL Database

How To Start

• Install dependencies with composser install.
• rename the .env.example file to .env
• add mysql database information on .env
• add TOKEN_SECRET for JWT
• setup SMTP Mail Environment
• setup Cloudinary Environment
• Run the server locally with php artisan serve
• run database migration with php artisan migration

Routes

• POST http://localhost:8000/api/auth/register
• POST http://localhost:8000/api/auth/login
• POST http://localhost:8000/api/auth/forget
• POST http://localhost:8000/api/auth/logout(need authorization)
• POST http://localhost:8000/api/auth/refresh(need authorization)
• GET http://localhost:8000/api/auth/me(need authorization)
• GET http://localhost:8000/api/user (need authorization)
• POST http://localhost:8000/api/user/create (need authorization)
• POST http://localhost:8000/api/user/update/{id} (need authorization)
• GET http://localhost:8000/api/user/delete/{id} (need authorization)
• GET http://localhost:8000/api/user/user/search?keyword={keyword} (need authorization)
• GET http://localhost:8000/api/user/paginate?per_page=10&page=1 (need authorization)
• POST http://localhost:8000/api/account/update (need authorization)
• PUT http://localhost:8000/api/account/change_password (need authorization)

Authorization

set Headers Authorization : Baarer<YOUR_TOKEN> example Authorization : BaarereyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI2Mjg4ODM4Y2U5YWZhMzViMmYxNTM3YjEiLCJpYXQiOjE2NTMxMTM3OTR9.7wdHLeDIxzJCm7ZyOWJSlk1b1HPp2Y4cxIVNzcnjf5g

Documentation

Authentication

1. Register

POST http://localhost:8000/api/auth/register

name: required
email: required|email|unique
password: required

Example suceess Responds:

{
    "response": 200,
    "success": true,
    "message": "Requests created successfully.",
    "data": true
}

2. Login

POST http://localhost:8000/api/auth/login

email: required
password: required

Example suceess Responds:

{
    "response": 200,
    "success": true,
    "message": "Login Successfully",
        "data": {
        "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC8xMjcuMC4wLjE6ODAwMFwvYXBpXC9hdXRoXC9sb2dpbiIsImlhdCI6MTY3OTcyODY4MSwiZXhwIjoxNjc5NzMyMjgxLCJuYmYiOjE2Nzk3Mjg2ODEsImp0aSI6ImI2RFc1TnBXVWc3bWJPd3MiLCJzdWIiOjQsInBydiI6IjIzYmQ1Yzg5NDlmNjAwYWRiMzllNzAxYzQwMDg3MmRiN2E1OTc2ZjcifQ.j3XBkTO-kH9Iu45jW_RJTb2nZiApiA01vwDZUCLqOQ4",
        "token_type": "bearer",
        "expires_in": 3600
    }
}

3. Forget

POST http://localhost:8000/api/auth/forget

email: required

Example suceess Responds:

{
    "response": 200,
    "success": true,
    "message": "email sent successfully",
    "data": []
}

4. Logout

POST http://localhost:8000/api/auth/logout

Example suceess Responds:

{
    "response": 200,
    "success": true,
    "message": "Successfully logged out",
    "data": []
}

5. Token Refresh

POST http://localhost:8000/api/auth/refresh

Example suceess Responds:

{
    "response": 200,
    "success": true,
    "message": "JWT Token refresh Successfully",
    "data": {
        "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC8xMjcuMC4wLjE6ODAwMFwvYXBpXC9hdXRoXC9yZWZyZXNoIiwiaWF0IjoxNjg4MjAwOTY1LCJleHAiOjE2ODgyMDQ1OTIsIm5iZiI6MTY4ODIwMDk5MiwianRpIjoiaU9FcGlTeUNFUXJid0ZKVSIsInN1YiI6MywicHJ2IjoiMjNiZDVjODk0OWY2MDBhZGIzOWU3MDFjNDAwODcyZGI3YTU5NzZmNyJ9.SLL3kTdpZ7c9t5PKg0pswHx20-_1KPB0uKUmkbRA3PU",
        "token_type": "bearer",
        "expires_in": 3600
    }
}

6. Me

GET http://localhost:8000/api/auth/me

Example suceess Responds:

{
    "id": 3,
    "name": "test",
    "email": "test@gmail.com",
    "email_verified_at": null,
    "photo": "avatar.png",
    "created_at": "2023-06-30T18:50:12.000000Z",
    "updated_at": "2023-06-30T18:51:04.000000Z"
}

CRUD

1. Read

GET http://localhost:8000/api/user

Example suceess Responds:

{
    "response": 200,
    "success": true,
    "message": "Read all user",
    "data": [
        {
            "id": 1,
            "Name": "test1",
            "Email": "test1@gmail.com",
            "Photo": "avatar.png",
            "Created_at": "2023-06-30T15:02:08.000000Z",
            "Updated_at": "2023-06-30T15:02:08.000000Z"
        },
        {
            "id": 2,
            "Name": "test2",
            "Email": "test2@gmail.com",
            "Photo": "avatar.png",
            "Created_at": "2023-06-30T18:50:12.000000Z",
            "Updated_at": "2023-06-30T18:51:04.000000Z"
        }
        {
            "id": 3,
            "Name": "test3",
            "Email": "test3@gmail.com",
            "Photo": "avatar.png",
            "Created_at": "2023-07-30T18:50:12.000000Z",
            "Updated_at": "2023-07-30T18:51:04.000000Z"
        }
    ]
}

2. Create

POST http://localhost:8000/api/user/create

name: required
email: required|email|unique:users
password: required
photo: required|image|mimes:jpeg,png,jpg,gif|max:2048

Example suceess Responds:

{
    "response": 200,
    "success": true,
    "message": "Create user",
    "data": []
}

3. Update

POST http://localhost:8000/api/user/update/{id}

name: required
email: required|email
photo: image|mimes:jpeg,png,jpg,gif|max:2048

Example suceess Responds:

{
    "response": 200,
    "success": true,
    "message": "update user with photo by id {id}",
    "data": []
}

4. Delete

GET http://localhost:8000/api/user/delete/{id}

Example suceess Responds:

{
    "response": 200,
    "success": true,
    "message": "Delete user by id {id}",
    "data": []
}

5. Search

GET http://localhost:8000/api/user/search?keyword={keyword}

Example suceess Responds:

{
    "response": 200,
    "success": true,
    "message": "Read user like {keyword}",
    "data": [
        {
            "id": 1,
            "Name": "test1",
            "Email": "fajar@gmail.com",
            "Photo": "avatar.png",
            "Created_at": "2023-06-30T15:02:08.000000Z",
            "Updated_at": "2023-06-30T15:02:08.000000Z"
        },
        {
            "id": 3,
            "Name": "test2",
            "Email": "test25@gmail.com",
            "Photo": "avatar.png",
            "Created_at": "2023-06-30T18:50:12.000000Z",
            "Updated_at": "2023-06-30T18:51:04.000000Z"
        },
    ]
}

6. Pagination

GET http://localhost:8000/api/user/paginate?per_page=10&page=1

Example suceess Responds:

{
    "response": 200,
    "success": true,
    "message": "Read user with pagination page 2",
    "data": [
        {
            "id": 1,
            "Name": "test1",
            "Email": "fajar@gmail.com",
            "Photo": "avatar.png",
            "Created_at": "2023-06-30T15:02:08.000000Z",
            "Updated_at": "2023-06-30T15:02:08.000000Z"
        },
        {
            "id": 3,
            "Name": "test2",
            "Email": "test25@gmail.com",
            "Photo": "avatar.png",
            "Created_at": "2023-06-30T18:50:12.000000Z",
            "Updated_at": "2023-06-30T18:51:04.000000Z"
        },
    ]
}

Account

1. Update Account

POST http://localhost:8000/api/account/update

name: required
email: required|email
photo: image|mimes:jpeg,png,jpg,gif|max:2048

Example suceess Responds:

{
    "response": 200,
    "success": true,
    "message": "User account update with photo successfully",
    "data": []
}

2. Password Change

PUT http://localhost:8000/api/user/change_password

password: required|string|min:6|confirmed
password_confirmation: required|string|min:6

Example suceess Responds:

{
    "response": 200,
    "success": true,
    "message": "Change password successfully",
    "data": []
}