Mengendalikan pengesahan API dengan Pasport Laravel

Editor PHP akan membawa anda meneroka menggunakan Pasport Laravel untuk mengendalikan pengesahan API Laravel Passport ialah pelaksanaan pelayan OAuth2 lengkap yang boleh membantu pembangun melaksanakan pengesahan API dengan mudah dan menyediakan banyak fungsi yang mudah. Melalui artikel ini, anda akan belajar cara menggunakan Pasport Laravel untuk mengurus pengesahan pengguna API dan memastikan keselamatan antara muka API.

Langkah 1. Pasang Laravel

Kita perlu menggunakan arahan berikut untuk mencipta aplikasi Laravel terkini, jadi sila buka terminal dan jalankan:

laravel new auth

Langkah 2. Pasang pakej Laravel Passport

Laravel Passport boleh digunakan dalam beberapa minit Aplikasi anda melaksanakan OAuth2 pelayan yang lengkap.

composer require laravel/passport

Langkah 3. Jalankan Pangkalan DataMigrasi

Penghijrahan pasport akan mencipta jadual yang digunakan oleh aplikasi anda untuk menyimpan pelanggan dan Token Akses.

PHP artisan migrate

Langkah 4. Jana kunci rahsia

Arahan ini akan mencipta kunci rahsia untuk menjana Token Akses yang secure. Di samping itu, ia juga akan mencipta akses peribadi dan passWord geran digunakan untuk menjana Token Akses:

php artisan passport:install

Selepas pelaksanaan, tambahkan LaravelPassportHasApiTokens trLaravelPassportHasApiTokens trait 添加到你的 AppUser 模型中。这个 trait 会为模型添加一系列助手函数用来验证用户的秘钥和作用域：

第五步 . Passport 配置

<?php

namespace App;

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

class User extends Authenticatable
{
    use Notifiable, HasApiTokens;
}

接下来，你应该在 AuthServiceProvider 中的 boot 方法中调用 Passport::routes 方法。这个方法会注册必要的路由去颁发访问令牌，撤销访问令牌，客户端和个人令牌：

<?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
{
    
    protected $policies = [
        &#39;App\Model&#39; => &#39;App\Policies\ModelPolicy&#39;,
    ];

    
    public function boot()
    {
        $this->reGISterPolicies();

        Passport::routes();
    }
}

最后，在 config/auth.php 配置文件中，你应该设置 api 权限认证守卫的 driver 选项为 passport。当需要权限认证的 API 请求进来时会告诉你的应用去使用 Passport's 的 TokenGuard。

'guards' => [
    'WEB' => [
        'driver' => 'session',
        'provider' => 'users',
    ],
    'api' => [
        'driver' => 'passport',
        'provider' => 'users',
    ],
],

第六步. 添加 API 路由

Laravel 提供了 routes/api.php 文件来给我们编写 web 路由，因此在这个文件添加新的路由即可。

<?php

use Illuminate\Http\Request;

Route::group([
    &#39;prefix&#39; => &#39;auth&#39;
], function () {
    Route::post(&#39;login&#39;, &#39;AuthController@login&#39;);
    Route::post(&#39;signup&#39;, &#39;AuthController@signup&#39;);

    Route::group([
      &#39;middleware&#39; => &#39;auth:api&#39;
    ], function() {
        Route::get(&#39;loGout&#39;, &#39;AuthController@logout&#39;);
        Route::get(&#39;user&#39;, &#39;AuthController@user&#39;);
    });
});

第七步: 创建控制器

最后一步我们必须创建新的控制器和 api 方法。因此我们先创建 AuthControllerai

anda Model AppUser. Ciri ini akan menambah satu siri fungsi pembantu pada model untuk mengesahkan kunci dan skop rahsia pengguna:

Langkah 5. Konfigurasi pasport

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use Carbon\Carbon;
use App\User;

class AuthController extends Controller
{
    
    public function signup(Request $request)
    {
        $request->validate([
            &#39;name&#39; => &#39;required|string&#39;,
            &#39;email&#39; => &#39;required|string|email|unique:users&#39;,
            &#39;password&#39; => &#39;required|string|confirmed&#39;
        ]);

        $user = new User([
            &#39;name&#39; => $request->name,
            &#39;email&#39; => $request->email,
            &#39;password&#39; => bcrypt($request->password)
        ]);

        $user->save();

        return response()->JSON([
            &#39;message&#39; => &#39;Successfully created user!&#39;
        ], 201);
    }

    
    public function login(Request $request)
    {
        $request->validate([
            &#39;email&#39; => &#39;required|string|email&#39;,
            &#39;password&#39; => &#39;required|string&#39;,
            &#39;remember_me&#39; => &#39;boolean&#39;
        ]);

        $credentials = request([&#39;email&#39;, &#39;password&#39;]);

        if(!Auth::attempt($credentials))
            return response()->json([
                &#39;message&#39; => &#39;Unauthorized&#39;
            ], 401);

        $user = $request->user();

        $tokenResult = $user->createToken(&#39;Personal Access Token&#39;);
        $token = $tokenResult->token;

        if ($request->remember_me)
            $token->expires_at = Carbon::now()->addWeeks(1);

        $token->save();

        return response()->json([
            &#39;access_token&#39; => $tokenResult->accessToken,
            &#39;token_type&#39; => &#39;Bearer&#39;,
            &#39;expires_at&#39; => Carbon::parse(
                $tokenResult->token->expires_at
            )->toDateTimeString()
        ]);
    }

    
    public function logout(Request $request)
    {
        $request->user()->token()->revoke();

        return response()->json([
            &#39;message&#39; => &#39;Successfully logged out&#39;
        ]);
    }

    
    public function user(Request $request)
    {
        return response()->json($request->user());
    }
}

Seterusnya, anda harus dalam <code>AuthServiceProvider The Passport::routes dipanggil dalam kaedah >boot. Kaedah ini akan mendaftarkan laluan yang diperlukan untuk mengeluarkan token akses, membatalkan token akses, pelanggan dan token peribadi:

---

php artisan serve

Akhir sekali, dalam fail konfigurasi config/auth.php, anda harus menetapkan pilihan pemandu untuk pengawal pengesahan kebenaran api ialah pasport. Apabila permintaan API yang memerlukan pengesahan kebenaran masuk, aplikasi anda akan diberitahu untuk menggunakan TokenGuard Pasport.

Content-Type: application/json
X-Requested-With: XMLHttpRequest

Langkah 6. Tambah penghalaan API

Laravel menyediakan fail routes/api.php untuk kami menulis laluan web, jadi cuma tambah laluan baharu dalam fail ini. rrreeeLangkah 7: Cipta Pengawal

Dalam langkah terakhir kita perlu mencipta kaedah pengawal dan api baharu. Jadi kami mula-mula mencipta AuthController dan meletakkan kod di dalamnya:

rrreee

Sekarang kami bersedia untuk menjalankan contoh kami, jalankan arahan berikut untuk menjalankan dengan cepat:

rrreee

Test

Kini, kami boleh menggunakan klien REST

alat

untuk memudahkan ujian, seperti Posmen. Saya menjalankan ujian dan anda boleh melihat tangkapan skrin di bawah.

Anda perlu menetapkan dua maklumat pengepala berikut untuk API ini: Pengguna

Terima kasih untuk membaca!

Sumber

---

GitHub

Koleksi posmen

Atas ialah kandungan terperinci Mengendalikan pengesahan API dengan Pasport Laravel. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!