Laravel 5.5 使用 Passport 服务做 API 认证

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

  • Register API
  • Login API
  • Get User Details API

接下来只需按照下面的步骤,我们就能很快速地将Passport集成到您的laravel项目中

1、首先安装,我们需要在项目中运行以下命令安装laravel的Passport软件包

composer require laravel/passport

2、安装成功之后,我们需要设置他们的服务提供者,所以打开config/app.php文件,并在其中添加以下代码

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

注: laravel5.5 以上版本可以忽略这一步骤,此步骤争对 5.5 以下版本

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

php artisan migrate

接下来我们安装 Passport 以生成令牌和客户端

php artisan passport:install

4、完成上面步骤,我们来配置下Passport

  • 打开 模型 app/User.php 我们需要增加 HasApiTokens
  • 打开 app/Providers/AuthServiceProvider.php 中增加 Passport::routers()
  • config/auth.php 中,更改 api 认证方式为 password

app/User.php

<?php

namespace App;

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

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',
    ];
}

app/Providers/AuthServiceProvider.php

<?php

namespace App\Providers;

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

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();
    }
}

config/auth.php

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

5、配置 routes/api.php 增加相应路由令牌

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');
});

6、接下来创建控制器

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);
    }
}

到此所有代码编写完成,接下来我们来测试使用它

php artisan serv

1、我们使用 postman 工具来测试 register api
file

2、测试 login api 使用第一步注册的邮箱和密码登录
file

3、使用第二步获取到的 token 值来获取用户信息
file

必须把Token值放到header头部信息里面才行。到此大功告成,需要的朋友可以拿走~

本作品采用《CC 协议》,转载必须注明作者和本文链接
本帖由系统于 5年前 自动加精
994914376
《L01 基础入门》
我们将带你从零开发一个项目并部署到线上,本课程教授 Web 开发中专业、实用的技能,如 Git 工作流、Laravel Mix 前端工作流等。
《L05 电商实战》
从零开发一个电商项目,功能包括电商后台、商品 & SKU 管理、购物车、订单管理、支付宝支付、微信支付、订单退款流程、优惠券等
讨论数量: 20

把 Token 值放到 header 头部信息 Authorization 里面的时候一定要记得在 token 字符串前面加上 Bearer 并和后面的token字符串隔开, 据了解是 Oauth2 必须加上这个 Bearer 希望以后看到这篇文章的小伙伴不要再踩到这个坑了 :smile:

5年前 评论
ThinkQ

file

5年前 评论
ThinkQ

:kissing_heart:

5年前 评论
颠倒的玉石

@scenery 我去,路由里你加个横杠杠干啥呀

5年前 评论
994914376

@scenery 哪个地方,对不起兄台,坑你了

5年前 评论

把 Token 值放到 header 头部信息 Authorization 里面的时候一定要记得在 token 字符串前面加上 Bearer 并和后面的token字符串隔开, 据了解是 Oauth2 必须加上这个 Bearer 希望以后看到这篇文章的小伙伴不要再踩到这个坑了 :smile:

5年前 评论

auth中间件在未登录的情况下,web端会跳转到登录页面,但是api请求我想返回json数据,这两种情况要兼容

5年前 评论
颠倒的玉石

每次登陆都会生成新的token,但是旧的也不过期,这样会不会不好啊

5年前 评论
ThinkQ

:+1:

5年前 评论
994914376

@scenery 那是因为你没有去处理它,如果有新的 tokan 生成了你应该自己去覆盖掉旧的,这样当旧的 token 过来时你检测下就可以了

5年前 评论

$success['token'] = $user->createToken('MyApp')->accessToken; 这个方法不存在吧,

5年前 评论
994914376

@kingcao 有的,你可以查看下源码

5年前 评论

The page has expired due to inactivity.
返回这个,是模拟POST请求的时候没有csrf_token?

5年前 评论

感觉这就是抄袭呀

5年前 评论
颠倒的玉石

file这里不加guard的话,他不会默认走

file这个session的guard么

5年前 评论

你写的这些很容易误导新手,还不如直接去看文档。你的接口命名和和返回的数据格式验证不符合restfull。而且passport提供了passwd授权方式。

5年前 评论

你这个中间件api找不到啊

5年前 评论

问一下,为什么这个token不会过期

5年前 评论
994914376

@TODO 因为注册时没有设置有效时长,可以在生成的时候把旧的重表里面删除掉就好了

5年前 评论

@994914376 有效时间设置的是两个小时,我试试把 数据删除试试

5年前 评论
994914376
在 EventServiceProvider.php 注册这个事件

 'Laravel\Passport\Events\AccessTokenCreated' => [
            'App\Listeners\PassportAccessTokenCreated'
        ],

实现监听代码

public function handle(AccessTokenCreated $event)
    {
        $provider = Config::get('auth.guards.api.provider');
        DB::table('oauth_access_token_providers')->insert([
            "oauth_access_token_id" => $event->tokenId,
            "provider" => $provider,
            "created_at" => new Carbon(),
            "updated_at" => new Carbon(),
        ]);
    }
5年前 评论

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!