3分鐘短文：太爽了，用Laravel寫API接口！

引言

我們一直在講，通過路由傳達到控制器，處理好資料并渲染到視圖，但是對于現代的應用，

前後端分離的情況下，後端寫個接口就完事兒了。

本期為大家說一說用laravel寫restful風格的API，看看能有多簡單。

以路由開端

寫API接口，與傳統的渲染前端模闆頁面有什麼差別？少了視圖，隻需要準備好資料，

并按照規則格式化，傳回就可以了。

laravel預設的api接口路由在 routes/api.php 檔案内定義，預設的情況下預定義了一個資源類型的api接口，代碼如下：

Route::middleware('auth:api')->get('/user', function (Request $request) {
    return $request->user();
});           

調用了 auth:api 中間件用于驗證使用者的授權，如果授權通過，聲明的get方法擷取使用者的資訊，并傳回 User 模型。這在之前的章節是很常見的操作，我們不做贅述了。

那麼這個路由檔案，是什麼時候加載上去的呢？在檔案 app/Providers/RouteServiceProvider.php 内，看這樣一段：

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

該服務提供者聲明路由使用 api 字元字首，并調用 api 中間件，該中間件定義在 app/Http/Kernel.php 檔案内：

protected $middlewareGroups = [
    'api' => [
        'throttle:60,1',
        \Illuminate\Routing\Middleware\SubstituteBindings::class,
    ],
];           

至于命名空間 $this->namespace 一般傳回 AppHttpControllers，我們為了區分API與其他應用，在目錄 app/Http/Controller 下建立 API 目錄，用于存儲所有API相關的控制器。

那麼上述的 RouteServiceProvider.php 檔案内 mapApiRoutes 方法内的 namespace 需要這樣寫：

->namespace($this->namespace . '\API')           

仍然以 Event 模型作為示例，在 routes/api.php 檔案内聲明一個資源類型的路由：

Route::resource('/events', 'API\EventsController');           

注意命名空間上多出來的字首 API\ ，這說明我們是把 EventController 檔案放在了 API 目錄下。

使用者權限

讓我們把目光還聚焦在系統預設聲明的那條路由：

Route::middleware('auth:api')->get('/user', function (Request $request) {
    return $request->user();
});           

注意中間件 auth:api，因為api請求是無狀态的，每次請求之間沒有任何關聯，是以使用使用者權限區分資源的傳回。那麼我們怎麼拿到使用者授權呢？這在 config/auth.php 檔案内定義，看系統自帶的這一段配置代碼：

'guards' => [
    'api' => [
        'driver' => 'token',
        'provider' => 'users',
        'hash' => false,
    ],
],           

這一段定義了我們使用何種方式認證使用者的身份。預設的驅動 token 定義在架構檔案 laravel/framework/src/Illuminate/Auth/TokenGuard.php 内。長話短說，預設構造類傳入的字段如下：

UserProvider $provider,
Request $request,
$inputKey = 'api_token',
$storageKey = 'api_token',
$hash = false           

簡單說，就是使用 users 表的 api_token 字段使用者鑒權。那麼預設我們 users 表顯然缺少一個這樣的字段，現在使用遷移檔案補上：

php artisan make:migration add_api_token_field_to_users_table --table=users           

首先是遷移方法 up 函數：

public function up()
{
    Schema::table('users', function (Blueprint $table) {
        $table->string('api_token', 60)->unique();
    });
}           

還有復原使用的 down 方法：

public function down()
{
    Schema::table('users', function (Blueprint $table) {
        $table->dropColumn('api_token');
    });
}           

這些都是正常操作，我們在之前的章節，使用了N多次了。執行指令遷移資料庫：

php artisan migrate           

看看效果

準備好了路由，而且路由内聲明了一個get方法傳回使用者模型資料。也準備好了資料庫表字段 api_token。我們在資料庫表内找到一個使用者資料，把api_token值設定為 1234，用于測試。

現在在浏覽器内請求類似如下的url位址：

http://www.example.com/api/user?api_token=1234           

如無異常，順利會輸出一個 json 字元串，

{
    "id":1,
    "provider":null,
    "provider_id":null,
    "first_name":"Tom",
    "last_name":"Hanks",
    "email":"[email protected]",
    "city":"",
    "state_id":null,
    "zip":"43016",
    "lat":null,"lng":null,
    "timezone":"America\/New_York",
    "title":"Laravel Developer",
    "created_at":"2020-10-14 17:46:19",
    "updated_at":"2020-10-14 17:46:20",
    "last_login_at":null,
    "is_admin":0,
    "api_token":"1234"
}           

這個json格式的資料是怎麼來的呢？是在路由内，$request->user() 方法傳回的User模型，使用 toArray() 格式化方法獲得的。為了示範，很多字段與實際可能有所出入。

特别需要注意的是，關鍵的密碼字段，以及 token 字段，是預設隐藏的，這得益于 User 模型内 $hiden 屬性的定義：

protected $hidden = [
    'password', 'remember_token',
];           

這些字段都對對外不公開通路。

寫在最後

本文介紹了如何聲明api位址，已經解釋了api從中間件到路由的由來，明白了api授權的方式，可以為我們更靈活地定制授權方式提供便利。這在laravel内都是可插拔的，替換為我們的邏輯代碼就可以愉快工作了。

Happy coding :-)

我是 @程式員小助手 ，專注程式設計知識，圈子動态的IT領域原創作者