Laravel6+ Dingo +Jwt 快速搭建 API系统,简单明了

19 篇文章 1 订阅
4 篇文章 0 订阅

友情提示:以下所有操作,在laravel6项目根目录下执行

1、安装dingo工具包
1)在根目录下的composer.json文件里面加上下面代码

"dingo/api": "^2.2"

在这里插入图片描述
2)执行命令来加载这个包的最新版本

composer update

在这里插入图片描述
2、安装jwt

composer require tymon/jwt-auth:dev-develop --prefer-source

在这里插入图片描述
在这里插入图片描述
3、配置项目config/app.php

Dingo\Api\Provider\LaravelServiceProvider::class,
Tymon\JWTAuth\Providers\LaravelServiceProvider::class,

在这里插入图片描述

'JWTAuth' => Tymon\JWTAuth\Facades\JWTAuth::class,
'JWTFactory' => Tymon\JWTAuth\Facades\JWTFactory::class,

在这里插入图片描述
4、发布配置文件

php artisan vendor:publish --provider="Dingo\Api\Provider\LaravelServiceProvider"  //生成 api.php
php artisan vendor:publish --provider="Tymon\JWTAuth\Providers\LaravelServiceProvider"  //生成 jwt.php

在这里插入图片描述
在这里插入图片描述
5、生成 JWT_SECRET 写入.env,配置config/api.php

php artisan jwt:secret

在这里插入图片描述

'jwt' => Dingo\Api\Auth\Provider\JWT::class

在这里插入图片描述
6、在 .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							// 调试模式

ps:在这里我只配了一个前缀,不配置会报错,后面的域名访问需要加上前缀

API_PREFIX=api							// 前缀

7、编辑用户模型,设置api,token生成方式

<?php

namespace App;

use Tymon\JWTAuth\Contracts\JWTSubject;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;

class User extends Authenticatable implements JWTSubject
{
    use Notifiable;

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'name', 'password',
    ];

    /**
     * The attributes that should be hidden for arrays.
     *
     * @var array
     */
    protected $hidden = [
        'password', 'remember_token',
    ];

    /**
     * The attributes that should be cast to native types.
     *
     * @var array
     */
    protected $casts = [
        'email_verified_at' => 'datetime',
    ];

    /**
     * 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 [];
    }
}

在这里插入图片描述

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

8、测试api
1)新建auth控制器

<?php
/**
 * Created by PhpStorm.
 * User: Administrator
 * Date: 2020/5/5
 * Time: 21:56
 */

namespace App\Http\Controllers\Api\v1;

use App\Http\Controllers\Controller;
use Illuminate\Support\Facades\Auth;
use Dingo\Api\Routing\Helpers;
use Illuminate\Support\Facades\Validator;
use Illuminate\Http\Request;
use App\User;

class AuthController extends Controller
{
    use Helpers;

    protected $guard = 'api';//设置使用guard为api选项验证,请查看config/auth.php的guards设置项,重要!

    /**
     * Create a new AuthController instance.
     *
     * @return void
     */
    public function __construct()
    {
        $this->middleware('auth:api', ['except' => ['login','register']]);
    }

    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 $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);
    }
}

在这里插入图片描述
ps:相关表的结构我这里稍微有点小改变,自己随机应变!

2)在routers/api.php中注册相关路由
//接管路由
$api = app('Dingo\Api\Routing\Router');

$api->version('v1',['namespace'=>'App\Http\Controllers\Api\v1'], function ($api) {

    $api->group(['prefix'=>'auth'],function ($api){
        $api->post('register','AuthController@register');
        $api->post('login','AuthController@login');
    });

});

3)使用postman测试
在这里插入图片描述
在这里插入图片描述

  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值