laravel5.4 使用Dingo/Api v2.0+Passport實現api認證

我學習laravel5.4的時候看官方文檔，有很多內容說的不夠詳細，很多朋友學習過程中會遇到不少坑，我這是其中之一，爬了兩天坑，才爬出來。

首先我這裏生成一個全新的laravel5.4項目。

安裝passport：

使⽤ Composer 依賴包管理器安裝 Passport ：

composer require laravel/passport

接下來，將 Passport 的服務提供者註冊到配置⽂件  config/app.php  的providers  數組中：

Laravel\Passport\PassportServiceProvider::class

Passport 使⽤服務提供者註冊內部的數據庫遷移腳本⽬錄，所以上⼀步完成後，你需要更新你的數據庫結構。Passport 的遷移腳本會⾃動創建應⽤程序需要的客戶端數據表和令牌數據表：

php artisan migrate

在.env 文件配置好數據庫，這裏不用多說了。laravel 5.4 改變了默認的數據庫字符集，默認字符編碼換成了utf8mb4,這裏還是說一下吧。

utf8 的 varchar 類型字符串最長255，換成utf8mb4最長是191，然而框架裏面默認長度還是用的 255 導致長度不夠了。

所以我們要修改app/Providers/AppServiceProvider.php ：

use Illuminate\Support\Facades\Schema; 

public function boot()
{
    Schema::defaultStringLength(191);
}

然後運行artisan生成數據表：

php artisan make:auth //必須先運行這個，因爲Passport 使用服務提供者註冊內部的數據庫遷移腳本目錄
php artisan migrate //再更新

然後運行 passport:install 命令來創建生成安全訪問令牌時用到的加密密鑰，同時，這條命令也會創建「私人訪問」客戶端和「密碼授權」客戶端：

php artisan passport:install

然後Laravel\Passport\HasApiTokens Trait 添加到 App\User 模型中，這個 Trait 會給你的模型提供一些輔助函數，用於檢查已認證用戶的令牌和使用作用域：

<?php

namespace App;

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

class User extends Authenticatable
{
protected $table = 'users'; //我的項目不知爲啥要加入這個，不加這個就出錯了，你們看自己情況 
use HasApiTokens, Notifiable;
}

接下來，需要在 AuthServiceProvider 的 boot 方法中調用 Passport::routes 函數。這個函數會註冊一些在訪問令牌、客戶端、私人訪問令牌的發放和吊銷過程中會用到的必要路由：

<?php

namespace App\Providers;

use Laravel\Passport\Passport;  //新增

class AuthServiceProvider extends ServiceProvider
{
    public function boot()
    {
        $this->registerPolicies();

        Passport::routes(); //新增

    }
}

配置文件 config/auth.php 中 api 部分的授權保護項（ driver ）改爲 passport 。

'guards' => [
    'web' => [
        'driver' => 'session',
        'provider' => 'users',
    ],

    'api' => [
        'driver' => 'passport',
        'provider' => 'users',
    ],
],

添加路由

    打開 routes/api.php 文件添加

 在這裏，我們添加了，註冊，登錄 ，詳情的路由

<?php

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

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

接着增加控制器，在APP/HTTP/Controller 目錄新增一個專門的API文件夾放

G:\WWW\liangzengyun> php artisan make:controller Api/UserController

在UserController控制器中添加:

<?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 UserController 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 details()
    {
        $user = Auth::user();
        return response()->json(['success' => $user], $this->successStatus);
    }
}

接下來，我們測試 一下接口：

 都能正常使用，

與dingo-api一起使用

你需要修改你的 composer.json 文件，然後執行 composer update 把最後一個版本的包加入你的項目

"require": {
    "dingo/api": "2.0.0-alpha1"
}

或者你可以在命令行執行 composer require 命令

composer require dingo/api:2.0.0-alpha1

打開 config/app.php，註冊必要的 service provider 在你的應用 providers 之前。

'providers' => [
    Dingo\Api\Provider\LaravelServiceProvider::class
]

再次設置更改路由，

打開 routes/api.php 文件添加

 

$api = app('Dingo\Api\Routing\Router');
$api->version('v1',function ($api) {
  $api->post('login', 'App\Http\Controllers\Api\UserController@login');
  $api->post('register', 'App\Http\Controllers\Api\UserController@register'); 
  $api->group(['middleware' => 'auth:api'], function($api){ 
   $api->post('details', 'App\Http\Controllers\Api\UserController@details'); 
 });
});

不多說，上圖：

這裏我們可以用剛纔生成的Client ID與Client Secret來密碼認證訪問，也可以測試一下注冊，登錄 與詳情頁面，都能正常訪問。（這幾個頁面的訪問不變）。

到些大功告成，大家有問題可以提出交流一下，哈！！