Laravel 5.5+ Dingo +Jwt 快速搭建 API系統
阿新 • • 發佈：2018-12-15
1，安裝Dingo
（1）首先更改composer.json裡面的內容，將此程式碼放入
"require":{
"dingo/api": "1.0.0-beta8"
},
"minimum-stability":"dev",（2）執行安裝
composer update2，安裝jwt
composer require tymon/jwt-auth:dev-develop --prefer-source3，配置
（1）config/app.config
"providers"=>[ ... Dingo\Api\Provider\LaravelServiceProvider::class, Tymon\JWTAuth\Providers\LaravelServiceProvider::class, ], 'aliases' => [ ... 'JWTAuth' => Tymon\JWTAuth\Facades\JWTAuth::class， 'JWTFactory' => Tymon\JWTAuth\Facades\JWTFactory::class ]
（2）釋出配置檔案
php artisan vendor:publish --provider="Dingo\Api\Provider\LaravelServiceProvider" //生成 api.php
php artisan vendor:publish --provider="Tymon\JWTAuth\Providers\LaravelServiceProvider" //生成 jwt.php
或者
php artisan vendoer:publish
選擇編號即可釋出（3）生成 JWT_SECRET 寫入.env
php artisan jwt:secret （4）config/api.php
'auth' => [
'jwt' => Dingo\Api\Auth\Provider\JWT::class
]（5）在 .env 中，把 dingo 配置在最後
API_STANDARDS_TREE=vnd // 環境 API_SUBTYPE=myapp // 子型別 API_PREFIX=api // 字首 API_DOMAIN=api.myapp.com //子域名 （字首和子域名只能存在一個）可選 API_VERSION=v1 // 版本 API_NAME=My API // 名字（使用API Blueprint命令才會用到） API_CONDITIONAL_REQUEST=false // 帶條件的請求 API_STRICT=false // Strict模式 API_DEFAULT_FORMAT=json // 響應格式 API_DEBUG=true // 除錯模式
上面的配置不是都是必要的，可根據實際情況進行選擇（上面配置時參考網路配置）,如：
API_STANDARDS_TREE=prs /vnd
API_SUBTYPE=laravelapi
API_PREFIX=api
API_VERSION=v1
API_DEBUG=false
API_DEFAULT_FORMAT=json（6）在routers/api.php中新建內容，兩個路徑分別是註冊和登入：
$api = app('Dingo\Api\Routing\Router');
$api->version('v1', function($api) {
$api->post('login', 'App\Http\Api\Auth\[email protected]');
$api->post('register', 'App\Http\Api\Auth\[email protected]');
$api->group(['middleware'=>'jwt.api.auth'],function($api){
$api->get('logout','App\Http\Api\Auth\[email protected]');
$api->get('user', 'App\Http\Api\[email protected]');
$api->get('refresh','App\Http\Api\Auth\[email protected]');
});
});
$api->version('v2', function($api) {
$api->get('version', function() {
return response('this is version v2');
});
});生成Controller
php artisan make:controller App\Http\Api\Auth\LoginController
php artisan make:controller App\Http\Api\Auth\RegisterController
php artisan make:controller App\Http\Api\Auth\RefreshController（7）建立資料認證模板，並使用資料遷移
php artisan make:model User -m //生成user 模型的同時，建立資料遷移
單獨生成遷移檔案
php artisan make:migration create_users_table修改內容
public function up()
{
Schema::create('users', function (Blueprint $table) {
$table->increments('id');
$table->string('name')->unique();
$table->string('email')->unique();
$table->string('password');
$table->rememberToken();
$table->timestamps();
});
}生成表
php artisan migrate（8）編輯驗證模板Model/Users.php
<?php
namespace App\Model;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Tymon\JWTAuth\Contracts\JWTSubject;
use Illuminate\Foundation\Auth\User as Authenticatable;
class Users extends Authenticatable implements JWTSubject
{
use Notifiable;
protected $fillable = ['name','email','password'];
protected $hidden = ['password','remember_token'];
public function getJWTIdentifier(){
return $this->getKey();
}
public function getJWTCustomClaims(){
return [];
}
}（9）註冊 RegisterController.php
<?php
namespace App\Http\Api\Auth;
use Illuminate\Http\Request;
use App\Http\Controllers\Controller;
use App\User;
use Dingo\Api\Routing\Helpers;
use Illuminate\Foundation\Auth\RegistersUsers;
use Illuminate\Support\Facades\Validator;
use Tymon\JWTAuth\Facades\JWTAuth;
class RegisterController extends Controller
{
use RegistersUsers;
use Helpers;
public function register(Request $request)
{
$validator = $this->validator($request->all());
if ($validator->fails()) {
throw new StoreResourceFailedException("Validation Error", $validator->errors());
}
$user = $this->create($request->all());
if ($user->save()) {
$token = JWTAuth::fromUser($user);
return $this->response->array([
"token" => $token,
"message" => "註冊成功",
"status_code" => 201,
]);
} else {
return $this->response->error("User Not Found...", 404);
}
}
public function validator($data)
{
return Validator::make($data,[
'name'=>'required|unique:users|max:10',
'email'=>'required|unique:users|email',
'password'=>'required|min:6']);
}
public function sendFailResponse($message)
{
return $this->response->error($message,400);
}
protected function create(array $data) {
return User::create([
'name' => $data['name'],
'email' => $data['email'],
'password' => bcrypt($data['password']),
]);
}
}
（10）登入 LoginController.php
<?php
namespace App\Http\Api\Auth;
use Illuminate\Http\Request;
use App\Http\Controllers\Controller;
use Illuminate\Support\Facades\Hash;
use Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException;
use Tymon\JWTAuth\Facades\JWTAuth;
use App\User;
use Dingo\Api\Routing\Helpers;
use Illuminate\Foundation\Auth\AuthenticatesUsers;
class LoginController extends Controller
{
use AuthenticatesUsers;
use Helpers;
public function login(Request $request)
{
$user=User::where('name',$request->email)->orwhere('email',$request->email)->firstOrFail();
if($user && Hash::check($request->password,$user->password)){
$token=JWTAuth::fromuser($user); //獲取token
$this->clearLoginAttempts($request); //清除登入次數
return $this->response->array([
'token'=>$token,
'message'=>"Login Success",
'status_code'=>200
]);
}
else{
throw new UnauthorizedHttpException("Login Failed");
}
}
public function logout(){
JWTAuth::invalidate(JWTAuth::getToken()); //token加入黑名單(登出)
$this->guard()->logout();
}
}
（11）重新整理LoginController.php
<?php
namespace App\Http\Api\Auth;
use Illuminate\Http\Request;
use App\Http\Controllers\Controller;
use Tymon\JWTAuth\Facades\JWTAuth;
use Dingo\Api\Routing\Helpers;
use Illuminate\Foundation\Auth\AuthenticatesUsers;
class RefreshController extends Controller
{
use AuthenticatesUsers;
use Helpers;
public function refresh(Request $request)
{
$old_token=JWTAuth::gettoken(); //獲取過期token
$new_token=JWTAuth::refresh($old_token); //重新整理token並返回
JWTAuth::invalidate($old_token); //銷燬過期token
return $this->response->array([
'token'=>$new_token,
'status_code'=>201
]);
}
}
4，每次請求需要加 Header
Authorization ：Bearer + token