bor3y/apitemplate

generate api code base

1.0.4 2018-11-18 16:00 UTC

Requires

• illuminate/support: ~5

Requires (Dev)

• mockery/mockery: ^1.1
• orchestra/testbench: ~3.0
• phpunit/phpunit: ~7.0
• sempro/phpunit-pretty-print: ^1.0

MIT

• Ahmed Elsayed

• laravel
• ApiTemplate

README

Make life easier

Installation

• install jwt for laravel Via Composer

$ composer require tymon/jwt-auth 1.0.0-rc.3

• Configure Auth guard change this lines in "config/auth.php"

guards' => [
    'api' => [
        'driver' => 'jwt',
        'provider' => 'users',
	    ],

• add to auth config "config/auth.php"

    /*
    |--------------------------------------------------------------------------
    | API Client Credentials
    |--------------------------------------------------------------------------
    |
    */

    'client_id' => env('CLIENT_ID', ''),
    'client_secret' => env('CLIENT_SECRET'. ''),

• Update your User model to implements "Tymon\JWTAuth\Contracts\JWTSubject"

    /**
     * Get the identifier that will be stored in the subject claim of the JWT.
     *
     * @return mixed
     */
    public function getJWTIdentifier()
    {
        return $this->getKey();
    }
    
    /**
     * Return a key value array, containing any custom claims to be added to the JWT.
     *
     * @return array
     */
    public function getJWTCustomClaims()
    {
        return [];
    }

• install our package Via Composer

$ composer require --dev bor3y/apitemplate

• publish package using command

$ php artisan auth:api:publish

• Add namespace to apiRoutes in "app/Providers/RouteServiceProvider.php"

    protected function mapApiRoutes()
    {
        Route::prefix('api')
             ->middleware('api')
             ->namespace($this->namespace . '\API')
              ->as('api.')
             ->group(base_path('routes/api.php'));
    }

• Add basic authentication routes

    Route::group(['prefix' => 'auth', 'namespace' => 'Auth'], function(){
        Route::group(['middleware' => 'auth.api.public'], function() {
            Route::post('/register', 'AuthController@register')->name('register');
            Route::post('/login', 'AuthController@login')->name('login');
            Route::group(['prefix' => 'password', 'as' => 'password.'], function(){
                Route::post('/forget', 'PasswordController@sendResetLinkEmail')->name('forget');
            });
            
            Route::post('/token/refresh', 'AuthController@refreshToken')->name('refreshToken');
        });
    
        Route::group(['middleware' => 'auth:api'], function(){
            Route::get('/user', ['as' => 'user', 'uses' => 'AuthController@user']);
            Route::post('/logout', ['as' => 'logout', 'uses' => 'AuthController@logout']);
            Route::post('/password/change', 'PasswordController@changePassword')->name('password.change');
        });
    });

• add to kernel routesMiddleware "app/Http/Kernel.php"

    'auth.api.public' => \App\Http\Middleware\AuthorizePublicApiRequests::class

We are done

License

license. Please see the license file for more information.