Skip to content

Latest commit

 

History

History
130 lines (95 loc) · 3.83 KB

README.md

File metadata and controls

130 lines (95 loc) · 3.83 KB
Raw

Lapas

You can use this project as a laravel passport sample project or just test it as a full Restful project.

Installation

Clone project:

git clone [email protected]:thisismahabadi/lapas.git

Run:

composer install

Create .env file and Copy .env.example to it:

cp .env.example .env

Migrate the database using:

php artisan migrate

Create the encryption keys needed to generate secure access tokens:

php artisan passport:install

and Finally serve the project:

php artisan serve

Back-End Documentation

Routes and Methods

Available routes and http methods:

POST: /api/v1/register - Register new user
POST: /api/v1/login - Login user
POST: /api/v1/logout - Logout from current user

This route works based on parameters:

GET: /api/v1/posts - Display a listing of the post
GET: /api/v1/posts?page={pageNumber} - Paginate the listing of the post
GET: /api/v1/posts?filter={columnName} - Filter the listing of the post
GET: /api/v1/posts?field={columnName}&value={orderingValue} - Sort the listing of the post
GET: /api/v1/posts?search={recordValues} - Search in the listing of the post

Or you can use every one of these routes together, like this:

GET /api/v1/posts?page=1&field=id&value=desc&search=hello&filter=id

These routes need sending datas in body:

POST: /api/v1/posts - Store a newly created post in database
GET: /api/v1/posts/{id} - Display the specified post
PUT: /api/v1/posts/{id} - Update the specified post in database
DELETE: /api/v1/posts/{id} - Remove the specified post from database

POST: /api/v1/refresh - Exchange a refresh token for an access token when the access token has expired

All of these routes except register and login and logout are provided with auth:api middleware which means you should send Authorization field in request header.

Passport and Other Configuration

First of all you should configure your project like what Laravel said in This official document.

In VerifyCsrfToken middleware I set $except array to following routes to avoid sending csrf-token in the body like this:

protected $except = [
    'api/v1/posts',
    'api/v1/posts/*',
    'api/v1/register',
    'api/v1/login',
    'api/v1/refresh',
    'api/v1/logout',
];

I added tokens lifetime in boot method of AuthServiceProvider like this:

Passport::tokensExpireIn(now()->addHours(1));

Passport::refreshTokensExpireIn(now()->addMonths(1));

Passport::personalAccessTokensExpireIn(now()->addHours(1));

Then I added throttle middleware in route to provide simple rate limiting like these:

Route::group(['middleware' => 'throttle:100,1'], function() {

Route::get('posts', ...)->middleware('throttle:100,1');

Which means you can send 100 request per minute and after that you should stay till 1 minute to re-send you requests.

Also you can change your User class to other directory or rename it or etc by changing 'model' in users providers in auth.php config file:

'providers' => [
    'users' => [
        'driver' => 'eloquent',
        'model' => Directory\User::class,
    ],

and I divided anything like Controller and Model and Request to the specific folder like Post and User and also use try-catch to handle some errors.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Alternatives

Also I used laravel-modules for creating modular project, and Backend with Laravel and Passport video, and Thanks to phpdoc to help me for writing comments for my code.