Vimigo Rest API Assessment

Requirements

1. You are required to do CRUD functions using User Model ([POST]/login & [POST]/register is not considered as part of CRUD)

2. The CRUD functions need to be REST API

3. Your API can only be accessed if the user is authenticated through Laravel Passport

4. All of your inputs need to be validated. You need to use Laravel Form Request Validation

5. Your [GET]/api/users able to filter by name and email, and the response must have pagination.

6. when retrieving the data, only need to show name and email using Laravel API Resource.

7. You also need to have an API to import excel/csv files to do bulk Create, Update and Delete users.

8. The project progress can be tracked using any version-control system (e.g: Upload in GitHub)

9. you MUST save all of the requests and responses as a Postman collection, and include the Postman JSON link in your README.md

Installation

• Clone the repository with git clone or download zip file
• Copy .env.example file to .env and edit database credentials there
• Run composer install
• Run php artisan key:generate
• Run php artisan migrate --seed
• Run php artisan passport:client --personal then copy the client_id and client_secret to .env
• Run php artisan serve
• Launch the main URL

Postman Collection

Postman JSON link

Endpoint

Method	Resources	Parameter	Description	Auth
POST	api/register	name, email, password, password_confirmation	Register a user to login	No
POST	api/login	email, password	Login to get personal access token	No
POST	api/logout	null	Logout a user and revoke personal access token	Yes
POST	api/users	name, email,password	Create a users	Yes
GET	api/users	null	Get all users (name, email)	Yes
PUT	api/users/{user}	name, email, password	Update a user	Yes
DELETE	api/users/{user}	null	Delete a user by id	Yes
GET	api/users/{user}	null	Get a user by id	Yes
POST	api/users/import	file	Import excel/csv to do bulk Create, Update, and Delete users	Yes