Laravel 5.4+ Dingo +Jwt 快速搭建 API系統
阿新 • • 發佈：2018-05-01
composer dingo jwt laravel5.5 api
剛進入新公司，比較忙，只能抽時間來寫寫比較簡短的博文總結，還望見諒。
最近公司要從實業轉型線上，決定用laravel 來做快速開發，而一些同事之前沒有用過laravel，尤其是api 的快速搭建，一致想讓我把搭建過程給分享出來，此為背景----也算是治療懶癌的動機 ^_^ ~~~
搭建過程記錄 ： 我們采用 laravel 5.4 ，因為5.6好像比這更簡潔，等我使用過後再來分享
__
創建 laravel 項目
composer create-project --prefer-dist laravle/laravel myProject ‘5.4.*‘__
安裝 Dingo + jwt
"require":{
"dingo/api": "1.0.0-beta8",
"tymon/jwt-auth": "1.0.0-beta.3"
},
"minimum-stability":"dev",執行安裝
composer update配置項目
config/app.php
"providers"=>[ ... Dingo\Api\Provider\LaravelServiceProvider::class, Tymon\JWTAuth\Providers\LaravelServiceProvider::class, ], ‘aliases‘ => [ ... ‘JWTAuth‘ => Tymon\JWTAuth\Facades\JWTAuth::class ]
config/api.php
‘auth‘ => [
‘jwt‘ => Dingo\Api\Auth\Provider\JWT::class
]發布配置文件 : 終端執行
php artisan vendor:publish --provider="Dingo\Api\Provider\LaravelServiceProvider" //生成 api.php
php artisan vendor:publish --provider="Tymon\JWTAuth\Providers\LaravelServiceProvider" //生成 jwt.php生成 jwt key 寫入.env
php artisan jwt:secret在 .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=vnd
API_SUBTYPE=emall
API_PREFIX=api
API_VERSION=v1__
路由：
在routers/api.php中新建內容，兩個路徑分別是註冊和登錄：
//接管路由
$api = app(‘Dingo\Api\Routing\Router‘);
$api->version(‘v1‘, function ($api) {
$api->post(‘login‘, ‘App\Http\Controllers\Api\Auth\LoginController@login‘);
$api->post(‘register‘, ‘App\Http\Controllers\Api\Auth\RegisterController@register‘);
});生成 Controller
php artisan make:controller Api/Auth/LoginController
php artisan make:controller Api/Auth/RegisterController __
數據庫配置 .env
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=51tbk.com
DB_USERNAME=root
DB_PASSWORD=123如果不適用laravel 自帶的認證系統，可以使用數據遷移
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編輯 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 [];
}
}__
註冊 RegisterController.php
<?php
namespace App\Http\Controllers\Api\Auth;
use App\Http\Controllers\Controller;
use App\User;
use Dingo\Api\Routing\Helpers;
use Illuminate\Foundation\Auth\RegistersUsers;
use Illuminate\Http\Request;
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);
}
}
protected function validator(array $data) {
return Validator::make($data, [
‘name‘ => ‘required|unique:users‘,
‘email‘ => ‘required|email|max:255|unique:users‘,
‘password‘ => ‘required|min:6‘,
]);
}
protected function create(array $data) {
return User::create([
‘name‘ => $data[‘name‘],
‘email‘ => $data[‘email‘],
‘password‘ => bcrypt($data[‘password‘]),
]);
}
}__
登錄 LoginController.php
<?php
use App\Http\Controllers\Controller;
use App\User;
use Dingo\Api\Routing\Helpers;
use Illuminate\Foundation\Auth\AuthenticatesUsers;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Hash;
use Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException;
use Tymon\JWTAuth\Facades\JWTAuth;
class LoginController extends Controller
{
use AuthenticatesUsers;
use Helpers;
public function login(Request $request) {
$user = User::where(‘email‘, $request->email)->orWhere(‘name‘, $request->email)->first();
if ($user && Hash::check($request->get(‘password‘), $user->password)) {
$token = JWTAuth::fromUser($user);
return $this->sendLoginResponse($request, $token);
}
return $this->sendFailedLoginResponse($request);
}
public function sendLoginResponse(Request $request, $token) {
$this->clearLoginAttempts($request);
return $this->authenticated($token);
}
public function authenticated($token) {
return $this->response->array([
‘token‘ => $token,
‘status_code‘ => 200,
‘message‘ => ‘User Authenticated‘,
]);
}
public function sendFailedLoginResponse() {
throw new UnauthorizedHttpException("Bad Credentials");
}
public function logout() {
$this->guard()->logout();
}
}__
獲取用戶信息
routes/api.php
$api->group([‘middleware‘ => ‘api.auth‘], function ($api) {
$api->get(‘user‘, ‘App\Http\Controllers\Api\UsersController@index‘);
});
php artisan make:controller Api/UsersController編輯 UsersController.php
每次請求需要加 Header
Authorization ：Bearer + tokenLaravel 5.4+ Dingo +Jwt 快速搭建 API系統