Please enable JavaScript.

Coggle requires JavaScript to display documents.

创建laravel的API (2.初步创建API接口 (2.2控制器操作 (2.2.3修改方法 (3.LessonsController初始化实现L…

- - - - 2.11 Route::group(['prefix'=>'v1'],function(){
        });
    - - Route::resource('lessons','LessonsController');
  - - - return Lesson::all();
    - - $lesson = Lesson::findOrFail($id);
        return $lesson;
    - - 1.创建抽象类 Transformer(transformCollection()法和抽象方法transform())
      - 2.创建LessonTransformer类，继承抽象类ransformer，实例化transform方法
      - 3.LessonsController初始化实现LessonTransformer，实现依赖反转
        
        index方法：
        $lessons = Lesson::all();
        return $this ->lessonTransformer->transformCollection($lessons->toArray())
        
        show方法：
        $lesson = Lesson::find($id);
        $this ->lessonTransformer->transform($lesson)
    - - 1.LessonsController继承ApiControlle
      - 2.修改ApiController类
        
        2.2 设置 response()方法
        
        private function response($data) {
        return \Response::json($data);
        }
        
        2.3 设置 responseSuccess()方法
        
        public function responseSuccess($message){
        return $this ->response([
        'status' => 'sucess',
        'code' => $this ->getCode(),
        'data' => $message,
        ]);
        }
        
        2.1 设置变量code，和getCode(),setCode()方法
        
        2.4设置responseError()方法
        
        private function responseError($message) {
        return $this ->response([
        'status' => 'failed',
        'code' => $this ->getCode(),
        'data' => $message,
        ]);
        }
        
        2.5设置responseNotFound()方法
        
        public function responseNotFound($message = 'Not Found'){
        return $this ->responseError($message);
        }
      - 3.修改LessonsController
        
        index()
        
        $lessons = Lesson::all();
        return $this ->responseSuccess($this ->lessonTransformer->transformCollection($lessons->toArray()));
        
        show()
        
        $lesson = Lesson::find($id);
        if(!$lesson){
        return $this->setCode(404) ->responseNotFound();
        }
        return $this ->responseSuccess($this ->lessonTransformer->transform($lesson));
  - - - Dingo API和JWT
        （输入用户名和密码，获取token,通过token获取数据）
        
        安装Dingoo扩展
        https://github.com/dingo/api/wiki/Installation
        
        composer.json
        require:{
        ......
        "dingo/api": "1.0.*@dev"
        }
        
        安装JWT
        https://github.com/tymondesigns/jwt-auth/wiki/Installation
        
        composer.json
        require:{
        ......
        "tymon/jwt-auth": "0.5.*"
        }
        
        更新依赖文件：composer update
        
        配置Dingo API（config/app.php）
        
        php artisan vendor:publish --provider="Dingo\Api\Provider\LaravelServiceProvider"
        
        会在config文件夹下面生成api.php文件
        
        'providers' => [
        Dingo\Api\Provider\LaravelServiceProvider::class
        ]
        
        配置Jwt（config/app.php）
        
        'providers' => [
        Tymon\JWTAuth\Providers\JWTAuthServiceProvider::class,
        ]
        
        'aliases' => [
        'JWTAuth' => Tymon\JWTAuth\Facades\JWTAuth::class,
        'JWTFactory' => Tymon\JWTAuth\Facades\JWTFactory::class,
        ]
        
        php artisan vendor:publish --provider="Tymon\JWTAuth\Providers\JWTAuthServiceProvider"
        
        会在config文件夹下面生成jwt.php文件
        
        php artisan jwt：generate
        
        使用Dingo API
        
        配置Kernel.php
        
        protected $routeMiddleware = [
        ......
        'jwt.auth' => \Tymon\JWTAuth\Middleware\GetUserFromToken::class,
        'jwt.refresh' => \Tymon\JWTAuth\Middleware\RefreshToken::class,
        ]
        
        配置.env
        
        API_STANDARDS_TREE=vnd
        API_PREFIX=api
        API_VERSION=v1
        API_DEBUG=true
        
        配置api.php
        
        'auth' => [
        'basic' => function($app){
        return new \Dingo\Api\Auth\Provider\Basic($app['auth']);
        }
        'jwt' => function($app){
        return new \Dingo\Api\Auth\Provider\JWT($app['Tymon\JWTAuth\JWTAuth']);
        }
        ],
        
        修改为：
        'auth' => [
        'jwt' => 'Dingo\Api\Auth\Provider\JWT',
        ]
        
        案例操作
        
        1.注册路由
        
        $api = app('Dingo\Api\Routing\Router');
        $api->version('v1', function ($api) {
        $api->group(['namespace' => 'App\Api\Controllers'], function ($api) {
        //路由名称
        });
        });
        
        2.实现路由
        
        1.在app文件夹下面创建api文件夹,并创建controller和 transformer
        
        创建LessonsController，继承BaseController
        
        创建LessonsTransformer，继承TransformerAbstract(dingo api提供)
        
        public function transform(Lesson $lesson)
        {
        return [
        'title' => $lesson['title'],
        'count' => $lesson['body'],
        'is_free' => $lesson['free'] ? '是' :'否',
        ];
        }
        
        创建BaseController控制器，use Helpers; //Dingo Api
        
        3.使用JWT
        
        创建身份验证控制器：AuthController，继承BaseController
        
        1.获取令牌
        $api->post('user/login','AuthController@authenticate');
        
        https://github.com/tymondesigns/jwt-auth/wiki/Creating-Tokens
        //进行身份验证
        public function authenticate(Request $request)
        {
        //定义成可以修改的参数
        $credentials = [
        'email' =>$request ->get('email'),
        'password' =>$request ->get('password'),
        ];
        try {
        if (! $token = JWTAuth::attempt($credentials)) {
        return response()->json(['error' => 'invalid_credentials'], 401);
        }
        } catch (JWTException $e) {
        return response()->json(['error' => 'could_not_create_token'], 500);
        }
        return response()->json(compact('token'));
        }
        
        4.用户注册
        $api->post('user/register','AuthController@register');
        
        public function register(Request $request)
        {
        if(!User::where('email', $request ->get('email'))->first()){
        $newUser = [
        'email' => $request ->get('email'),
        'name' => $request ->get('name'),
        'password' => bcrypt($request ->get('password')),
        ];
        $user = User::create($newUser);
        $token = JWTAuth::fromUser($user);
        return response()->json(compact('token'));
        } else {
        return response()->json(['error' => '用户已存在'], 401);
        }
        }
        
        5.根据用户token，获取用户信息
        $api->group(['middleware'=>'jwt.auth'],function($api){
        $api->get('user/me','AuthController@getAuthenticatedUser');
        }
        
        https://github.com/tymondesigns/jwt-auth/wiki/Authentication
        public function getAuthenticatedUser()
        {
        try {
        if (! $user = JWTAuth::parseToken()->authenticate()) {
        return response()->json(['user_not_found'], 404);
        }
        } catch (TokenExpiredException $e) {
        return response()->json(['token_expired'], $e->getStatusCode());
        } catch (TokenInvalidException $e) {
        return response()->json(['token_invalid'], $e->getStatusCode());
        } catch (JWTException $e) {
        return response()->json(['token_absent'], $e->getStatusCode());
        }
        //return response()->json(compact('user'));
        return $this ->item($user,new UserTransformer()); //修改返回的字段映射
        
        }
        
        2.获取数据
        $api->group(['middleware'=>'jwt.auth'],function($api){
        $api->get('lessons','LessonsController@index');
        }
        
        public function index(){
        $lessons = Lesson::all();
        return $this ->collection($lessons,new LessonsTransformer());
        }
        
        3.获取单个数据
        $api->group(['middleware'=>'jwt.auth'],function($api){
        $api->get('lessons/{id}','LessonsController@show');
        }
        
        public function show($id)
        {
        $lesson = Lesson::find($id);
        if(!$lesson){
        return $this ->response()->errorNotFound('Lesson not found'); //Dingo Api提供的
        }
        return $this ->item($lesson,new LessonsTransformer());
        }
      - 基础验证模块(auth.basic)
        (输入用户名和密码，获取数据)
        
        App/Kernel.php 的 $middlewareGroups 的 auth.basic
        
        在构造函数添加:
        $this ->middleware('auth.basic',['only'=>['store','update','destroy']]);
        
        store()方法:
        if(!$request->get('title') or ! $request ->get('body')){
        return $this->setCode(422) ->responseError('validate fails!!验证失败');
        }
        Lesson::create($request->all());
        return $this ->setCode(201)->responseSuccess('创建成功');
        
        对应users表的email和password
      - OAuth
        
        laravel5.3添加了API认证（Passport）
        
        配置
        
        在配置文件config/app.php的providers数组中注册Passport服务提供者：
        Laravel\Passport\PassportServiceProvider::class,
        
        Passport服务提供着为框架注册了自己的数据库迁移目录，所以在注册之后需要迁移数据库
        php artisan migrate
        
        接下来，需要运行passport:install命令，该命令将会创建生成安全访问令牌（token）所需的加密键，此外，该命令还会创建“personal access”和“password grant”客户端用于生成访问令牌：
        php artisan passport:install
        
        在App\User添加
        use HasApiTokens, Notifiable;
        
        在AuthServiceProvider的boot方法中调用Passport::routes方法，该方法将会注册发布/撤销访问令牌、客户端以及私人访问令牌所必需的路由
        Passport::routes();
        
        在配置文件config/auth.php中，需要设置api认证guard的driver选项为passport。这将告知应用在认证输入的API请求时使用Passport的TokenGuard：
        'driver' => 'passport',
        
        生成数据表:
        php artisan make:auth
        
        使用Composer包管理器安装Passport：
        composer require laravel/passport=1.
        (laravel5.3默认只支持passport 1.)
    - - 修改方法：App/Kernel.php 的 $middlewareGroups 的 \App\Http\Middleware\VerifyCsrfToken::class 注释掉
- - - - php artisan make:migration create_lessons_table --create=lessons
    - - php artisan make:model Lesson
    - - php artisan make:controller LessonsController
    - - 在CreateLessonsTable添加需要的字段(database/migrate)
        
        $table ->text('body');
        
        $table ->boolean('free');
        
        $table ->string('title');
    - - php artisan migrate
    - - 在databese/factories/ModelFactory.php里面添加数据
        
        $factory->define(App\Lesson::class, function (Faker\Generator $faker) {
        return [
        'title' => $faker->sentence,
        'body' => $faker->paragraph,
        'free' => $faker->boolean(),
        ];
        });
      - 命令行代码，添加猜测书数据
        
        factory(Lesson::class,60)->create()
        
        namespace App;
        
        php artisan tinker