Laravel Passport - 创建 REST API 用户认证

今天，在本教程中，我们将与您分享如何在您的laravel应用程序中使用laravel Passport认证。 Laravel已经为Web提供了简单的认证系统。但是API呢？ API基本上使用令牌进行身份验证。当任何用户登录然后生成一个tocken，并将其用于身份验证的目的。所以，laravel提供了API认证的Passport。

原文链接：https://laravelcode.com/post/laravel-passport-create-rest-api-with-authentication#

如何在laravel中使用Passport来构建RESTful API以及如何在laravel应用程序中进行配置。在这里，我们正在以一种非常简单的方式和例子一步步地展开所有的事情。

在本教程中，我们使用Passport构建了以下API服务：

1. Register API
2. Login API
3. Get User Details API

只需按照此步骤，您就可以轻松地将Passport集成到您的laravel应用程序中。

Step - 1 : Installation

步骤1：安装首先，我们需要使用运行以下命令在您的应用程序中安装laravel的Passport软件包。


composer require laravel/passport

Step - 2 : Configure Pacckage

成功安装Passport包之后，我们需要设置他们的服务提供者。所以，打开你的config / app.php文件，并在其中添加以下提供程序。


'providers' => [
	....
	Laravel\Passport\PassportServiceProvider::class,
],

Step - 3 : Run Migration And Install

注册之后，迁移数据表。Passport会生成用于储存客户端和令牌的数据表。

 php artisan migrate

下一步，我们来安装Passport，以生成令牌和客户端。


 php artisan passport:install

Step - 4 : Passport Configure

完成上面的步骤，我们可以配置一下Passport。

1. 在Model中，我们需要增加 HasApiTokens class，
2. 在AuthServiceProvider中，增加 "Passport::routes()"，
3. 在 auth.php中，更改 api 认证方式为password.

1. app/User.php


namespace App;

use Laravel\Passport\HasApiTokens;
use Illuminate\Notifications\Notifiable;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable
{
    use HasApiTokens, Notifiable;

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'name', 'email', 'password',
    ];

    /**
     * The attributes that should be hidden for arrays.
     *
     * @var array
     */
    protected $hidden = [
        'password', 'remember_token',
    ];
}

2. app/Providers/AuthServiceProvider.php


namespace App\Providers;

use Laravel\Passport\Passport;
use Illuminate\Support\Facades\Gate;
use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;

class AuthServiceProvider extends ServiceProvider
{
    /**
     * The policy mappings for the application.
     *
     * @var array
     */
    protected $policies = [
        'App\Model' => 'App\Policies\ModelPolicy',
    ];

    /**
     * Register any authentication / authorization services.
     *
     * @return void
     */
    public function boot()
    {
        $this->registerPolicies();
        Passport::routes();
    }
}

3. config/auth.php


return [
	.....
    .....
    'guards' => [
        'web' => [
            'driver' => 'session',
            'provider' => 'users',
        ],
        'api' => [
            'driver' => 'passport',
            'provider' => 'users',
        ],
    ],
    .....
    .....
]

Step - 5 : Create Route

Next，配置 routes/api.php ，增加相应API路由配置


Route::post('login', 'API\PassportController@login');
Route::post('register', 'API\PassportController@register');

Route::group(['middleware' => 'auth:api'], function(){
	Route::post('get-details', 'API\PassportController@getDetails');
});

Step - 6 : Create Controller

下一步，我们创建一个控制器PassportController.php放在 app/Http/Controllers/API/

在此之前，需要在 app/Http/Controllers/下创建一个API文件夹来储存我们的API控制器

app/Http/Controllers/API/PassportController.php


namespace App\Http\Controllers\API;

use Illuminate\Http\Request;
use App\Http\Controllers\Controller;
use App\User;
use Illuminate\Support\Facades\Auth;
use Validator;

class PassportController extends Controller
{

    public $successStatus = 200;

    /**
     * login api
     *
     * @return \Illuminate\Http\Response
     */
    public function login(){
        if(Auth::attempt(['email' => request('email'), 'password' => request('password')])){
            $user = Auth::user();
            $success['token'] =  $user->createToken('MyApp')->accessToken;
            return response()->json(['success' => $success], $this->successStatus);
        }
        else{
            return response()->json(['error'=>'Unauthorised'], 401);
        }
    }

    /**
     * Register api
     *
     * @return \Illuminate\Http\Response
     */
    public function register(Request $request)
    {
        $validator = Validator::make($request->all(), [
            'name' => 'required',
            'email' => 'required|email',
            'password' => 'required',
            'c_password' => 'required|same:password',
        ]);

        if ($validator->fails()) {
            return response()->json(['error'=>$validator->errors()], 401);            
        }

        $input = $request->all();
        $input['password'] = bcrypt($input['password']);
        $user = User::create($input);
        $success['token'] =  $user->createToken('MyApp')->accessToken;
        $success['name'] =  $user->name;

        return response()->json(['success'=>$success], $this->successStatus);
    }

    /**
     * details api
     *
     * @return \Illuminate\Http\Response
     */
    public function getDetails()
    {
        $user = Auth::user();
        return response()->json(['success' => $user], $this->successStatus);
    }
}

Allright, 完成！！API配置已经结束，让我们运行服务器来测试它。


php artisan serve

Step - 7 : APIs Testing

Now, 我们测试API使用Postman，在谷歌浏览器插件里可以安装它。

1. Register API

2. Login API

3. Get Detailss API

Now，我们来测试API数据获取，我们需要添加headers在测试Postman中，$accessToken使用Login中的Token即可。


'headers' => [
    'Accept' => 'application/json',
    'Authorization' => 'Bearer '.$accessToken,
]

Laravel Passport - 创建 REST API 用户认证

猜你喜欢