dingo api 中文文檔： https://www.bookstack.cn/read...
Laravel中使用JWT：https://laravel-china.org/art...
輔助文章： https://www.jianshu.com/p/62b...
參考https://www.jianshu.com/p/62b... 這篇文章基本就能搭建出環境，我使用的版本跟他一樣 "dingo/api": "2.0.0-alpha1","tymon/jwt-auth": "^1.0.0-rc.1"，不知道別的版本有啥大的區別，但是網上找的其他一些文章使用的是舊的版本，jwt封裝的東西路徑可能不一樣，可能會保錯，有些文檔還說要手動添加TymonJWTAuthProvidersLaravelServiceProvider::class和DingoApiProviderLaravelServiceProvider::class，其實新版本不需要。
1. composer.json引入包,執行composer update：
"require": {
......
"dingo/api": "2.0.0-alpha1",
"tymon/jwt-auth": "^1.0.0-rc.1"
},2. 執行下面兩個語句自動生成dingo和jwt的配置文件：
php artisan vendor:publish --provider="Dingo\Api\Provider\LaravelServiceProvider"
//config文件夾中生成dingo配置文件---> api.phpphp artisan vendor:publish --provider="Tymon\JWTAuth\Providers\LaravelServiceProvider"
//config文件夾中生成dingo配置文件---> jwt.php3. 配置 .env
具體配置可參考 文檔https://www.bookstack.cn/read... ，我的配置是
API_STANDARDS_TREE=vnd
API_PREFIX=api
API_VERSION=v1
API_DEBUG=true
API_SUBTYPE=myapp 還需在命令行執行 php artisan jwt:secret，會在.env自動添加JWT_SECRET，其他若需要，可以到各種的配置文件中看，在.env添加即可
4. 關鍵處理
'defaults' => [
'guard' => 'web',
'passwords' => 'users',
],
'guards' => [
'web' => [
'driver' => 'session',
'provider' => 'users',
],
'api' => [
'driver' => 'jwt',
'provider' => 'users',
],
],這裏需要把api原本的driver => session 改爲使用jwt機制，provider對應你要用的用戶認證表，一般就是登錄註冊那張表
<?php
namespace App\Models;
use Tymon\JWTAuth\Contracts\JWTSubject;
use Illuminate\Notifications\Notifiable;
use Illuminate\Foundation\Auth\User as Authenticatable;
class User extends Authenticatable implements JWTSubject {
use Notifiable;
/**
* The attributes that are mass assignable.
*
* @var array
*/
protected $fillable = [
'name', 'email', 'password', 'unionid'
];
/**
* The attributes that should be hidden for arrays.
*
* @var array
*/
protected $hidden = [
'password', 'remember_token',
];
// Rest omitted for brevity
/**
* Get the identifier that will be stored in the subject claim of the JWT.
*
* @return mixed
*/
public function getJWTIdentifier() {
return $this->getKey();
}
/**
* Return a key value array, containing any custom claims to be added to the JWT.
*
* @return array
*/
public function getJWTCustomClaims() {
return [];
}
}5. 設置控制器
考慮到可能後面需要開發不同版本api，所以在app/Http/Controller下建立了V1，V2目錄，根據你自己的需求來，只要寫好命名空間就ok
<?php
/**
* Date: 17/10/12
* Time: 01:07
*/
namespace App\Http\Controllers\V1;
use App\Http\Controllers\Controller;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use Validator;
use App\User;
class AuthController extends Controller
{
protected $guard = 'api';//設置使用guard爲api選項驗證，請查看config/auth.php的guards設置項，重要！
/**
* Create a new AuthController instance.
*
* @return void
*/
public function __construct()
{
$this->middleware('refresh', ['except' => ['login','register']]);
}
public function test(){
echo "test!!";
}
public function register(Request $request)
{
$rules = [
'name' => ['required'],
'email' => ['required'],
'password' => ['required', 'min:6', 'max:16'],
];
$payload = $request->only('name', 'email', 'password');
$validator = Validator::make($payload, $rules);
// 驗證格式
if ($validator->fails()) {
return $this->response->array(['error' => $validator->errors()]);
}
// 創建用戶
$result = User::create([
'name' => $payload['name'],
'email' => $payload['email'],
'password' => bcrypt($payload['password']),
]);
if ($result) {
return $this->response->array(['success' => '創建用戶成功']);
} else {
return $this->response->array(['error' => '創建用戶失敗']);
}
}
/**
* Get a JWT token via given credentials.
*
* @param \Illuminate\Http\Request $request
*
* @return \Illuminate\Http\JsonResponse
*/
public function login(Request $request)
{
$credentials = $request->only('email', 'password');
if ($token = $this->guard()->attempt($credentials)) {
return $this->respondWithToken($token);
}
return $this->response->errorUnauthorized('登錄失敗');
}
/**
* Get the authenticated User
*
* @return \Illuminate\Http\JsonResponse
*/
public function me()
{
//return response()->json($this->guard()->user());
return $this->response->array($this->guard()->user());
}
/**
* Log the user out (Invalidate the token)
*
* @return \Illuminate\Http\JsonResponse
*/
public function logout()
{
$this->guard()->logout();
//return response()->json(['message' => 'Successfully logged out']);
return $this->response->array(['message' => '退出成功']);
}
/**
* Refresh a token.
*
* @return \Illuminate\Http\JsonResponse
*/
public function refresh()
{
return $this->respondWithToken($this->guard()->refresh());
}
/**
* Get the token array structure.
*
* @param string $token
*
* @return \Illuminate\Http\JsonResponse
*/
protected function respondWithToken($token)
{
return response()->json([
'access_token' => $token,
'token_type' => 'bearer',
'expires_in' => $this->guard()->factory()->getTTL() * 60
]);
}
/**
* Get the guard to be used during authentication.
*
* @return \Illuminate\Contracts\Auth\Guard
*/
public function guard()
{
return Auth::guard($this->guard);
}
}控制器中命名空間namespace需要設置好，路由的時候需要用到，$this->middleware('refresh', ['except' => ['login','register']]);
這裏的中間件使用的是網上找的，用於無痛刷新jwt的token,具體可以參考這篇文章：https://www.jianshu.com/p/9e9...
6. refresh中間件
<?php
namespace App\Http\Middleware;
use Closure;
use Tymon\JWTAuth\Exceptions\JWTException;
use Tymon\JWTAuth\Http\Middleware\BaseMiddleware;
use Tymon\JWTAuth\Exceptions\TokenExpiredException;
use Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException;
class RefreshToken extends BaseMiddleware
{
/**
* @author: zhaogx
* @param $request
* @param Closure $next
* @return \Illuminate\Http\JsonResponse|\Illuminate\Http\Response|mixed
* @throws JWTException
*/
public function handle($request, Closure $next)
{
// 檢查此次請求中是否帶有 token，如果沒有則拋出異常。
$this->checkForToken($request);
// 使用 try 包裹，以捕捉 token 過期所拋出的 TokenExpiredException 異常
try {
// 檢測用戶的登錄狀態，如果正常則通過
if ($this->auth->parseToken()->authenticate()) {
return $next($request);
}
throw new UnauthorizedHttpException('jwt-auth', '未登錄');
} catch (TokenExpiredException $exception) {
// 此處捕獲到了 token 過期所拋出的 TokenExpiredException 異常，我們在這裏需要做的是刷新該用戶的 token 並將它添加到響應頭中
try {
// 刷新用戶的 token
$token = $this->auth->refresh();
// 使用一次性登錄以保證此次請求的成功
\Auth::guard('api')->onceUsingId($this->auth->manager()->getPayloadFactory()->buildClaimsCollection()->toPlainArray()['sub']);
} catch (JWTException $exception) {
// 如果捕獲到此異常，即代表 refresh 也過期了，用戶無法刷新令牌，需要重新登錄。
throw new UnauthorizedHttpException('jwt-auth', $exception->getMessage());
}
}
return $next($request)->withHeaders([
'Authorization'=> 'Bearer '.$token,
]);
}
}寫好中間件後需要在app/Http/Kernel.php中注入
protected $routeMiddleware = [
......
'refresh' => RefreshToken::class,
];
7. routes/api.php 設置路由
$api = app('Dingo\Api\Routing\Router');
$api->version('v1', ['namespace' => 'App\Http\Controllers\V1'], function ($api) {
$api->post('register', 'AuthController@register');
$api->post('login', 'AuthController@login');
$api->post('logout', 'AuthController@logout');
$api->post('refresh', 'AuthController@refresh');
$api->post('me', 'AuthController@me');
$api->get('test', 'AuthController@test');
});這裏有個坑，不要這樣寫$api->post('me',['middleware' =>'refresh'], 'AuthController@me');
這樣雖然能執行這個中間件但執行到$next($request)這裏會出錯，貌似是一個回調報錯 Function name must be a string ，不太清楚具體原因，可以這樣寫$api->post('me',, 'AuthController@me')->middleware('refresh');
根據以上幾個步驟就可以建立起簡單的api後臺基礎，獲取api路由列表可以使用命令行： php artisan api:routes
routes:list貌似無法顯示以上api路由，需要在api.php那裏再寫一遍原始的laravel路由定義纔可以顯示：比如這樣Route::post('api/test', 'AuthController@test');後續會用另一篇幅來記錄postman和小程序相關知識，可以關注我的博客：https://zgxxx.github.io