欢迎各位兄弟 发布技术文章

这里的技术是共享的

You are here

laravel和dingoapi的结合使用 有大用 有大大用

可以结合 /node-admin/9973  看看

也可以结合 /node-admin/9996  看看

dingoapi是一个laravel的开源插件,可以在github上搜索到,现在在做一个项目,项目中总是会有后端跟前端的json数据交互,而这个dingoapi为json交互提供了很大的便利。

先安装dingoapi

1、在composer.json中的require中添加"dingo/api": "1.0.*@dev",然后在项目根目录运行composer update

注意:dingoapi如果直接用composer require dingo/api:1.0.x@dev的方式安装是安装不成功的,
(不过我用这种方法是可以正常安装的)

因为这个包作者本人还是将其设置为开发中,非稳定版,但是实际上这个包经过验证是稳定的,已经有4500+的star了。

2、在config/app.php中注册服务提供者到providers

Dingo\Api\Provider\LaravelServiceProvider::class,

3、生成dingoapi的配置文件

php artisan vendor:publish --provider="Dingo\Api\Provider\LaravelServiceProvider"

会在config文件夹里生成api.php这个配置文件

我的方法是

API_STANDARDS_TREE=x
API_SUBTYPE=rest
API_NAME="REST"
API_PREFIX=api
API_VERSION=v1
API_CONDITIONAL_REQUEST=true
API_STRICT=false
API_DEBUG=false
API_DEFAULT_FORMAT=json


在 env中配置  api

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 // 调试模式

4、将api.php中的prefix默认值设置为api,也可以不是api,但是必须要有个后缀,后缀不要设置为"/",如果设置为"/",laravel的视图跟api会弄混淆,比如,在laravel中自定义了一个404错误页面,如果这里设置为"/"的话,访问不存在的页面的时候,会返回格式为json的错误信息,因为dingapi就是做接口用的,不管什么都会被转为json。

那如果想把视图跟api区分开来,路由文件需要这么写,以下是例子:

复制代码
<?php

/*
|--------------------------------------------------------------------------
| Web Routes
|--------------------------------------------------------------------------
|
| This file is where you may define all of the routes that are handled
| by your application. Just tell Laravel the URIs it should respond
| to using a Closure or controller method. Build something great!
|
*/
Route::post('/test','AdminController@test');
Route::post('/hook','HookController@hook');
#后台管理系统登录视图
Route::get('/admin','AdminController@loginView');
Route::get('/admin/login','AdminController@loginView');
#后台管理系统登录api
Route::post('/admin/login','AdminController@login');
#退出登录api
Route::get('/logout','UserController@logout');
#管理员可见视图
Route::group(['middleware' => ['role:admin']], function () {
    #用户列表视图
    Route::get('/users','AdminController@users');
    #添加用户视图
    Route::get('/add_user','AdminController@addUserView');
    #机修列表视图
    Route::get('/mechanics_list','MechanicsController@dataList'); 
    #配件列表视图
    Route::get('/parts_list','PartsController@dataList'); 
    #添加配件视图
    Route::get('/add_part','PartsController@addView');
    Route::match(['get','post'],'/mechanics_add', 'MechanicsController@add');
    Route::get('/edit_user/{id}','AdminController@editUserView');
    Route::get('/video',function(){
        return view('video',['title'=>"视频播放"]);
    });
});


$api = app('Dingo\Api\Routing\Router');
$api->version('v1', function ($api) {
    $api->group(['namespace' => 'App\Http\Controllers\Api'], function ($api) {
//namespace声明路由组的命名空间,因为上面设置了"prefix"=>"api",所以以下路由都要加一个api前缀,比如请求/api/users_list才能访问到用户列表接口
        $api->group(['middleware'=>['role:admin']], function ($api) {
        #管理员可用接口
            #用户列表api
            $api->get('/users_list','AdminApiController@usersList');
            #添加用户api
            $api->post('/add_user','AdminApiController@addUser');
            #编辑用户api
            $api->post('/edit_user','AdminApiController@editUser');
            #删除用户api
            $api->post('/del_user','AdminApiController@delUser');
            #上传头像api
            $api->post('/upload_avatar','UserApiController@uploadAvatar');
            
        });
        
    });
});
复制代码

 

需要新建一个BaseController:

复制代码
<?php

namespace App\Http\Controllers\Api;

use Dingo\Api\Routing\Helpers;
use App\Http\Controllers\Controller;

class BaseController extends Controller
{
    use Helpers;
}
复制代码

然后做接口的控制器都继承这个BaseController

这些做接口的控制器放Api文件夹里

然后如果用了Requests做验证,需要将原本request里的use Illuminate\Foundation\Http\FormRequest换成use Dingo\Api\Http\FormRequest;

不然的话不能明确的显示验证错误的消息。

以下是我用到dingoapi的一些功能:

第一个功能:

当我用jquery的ajax请求服务器的数据的时候,ajax其实有两个参数,success的回调函数和error的回调函数,在laravel中,如果我直接return响应一个数组,laravel框架会自动的将这个数组变成json格式的响应,所以我在laravel代码写类似下面的代码:

if($error){
    return ['status'=>'error',''=>'message'=>'未通过验证'];    //返回200响应码,但是返回status为error的标识

}
return ['status'=>'success',''=>'message'=>'操作成功'];      //返回200响应码,并且返回status为success的标识

这个时候前端jquery的success的回调函数可以根据status这个标识来判断操作是否成功:

复制代码
dataType:'json',          //注意这里要写json,标识服务器返回的是json,jquery会将这个json字符串转化为json对象方便下面获取数据
success:function(res){
     if(res.status == 'error'){
    alert(res.message);    //这里会alert一个“未通过验证”
   }
   else{
     alert(res.message);   //这里会alert一个“操作成功”
   }

}
复制代码

这样是一种前端跟后端传递数据的方法,不管操作成功或者失败都返回200的正确响应,根据status来判断操作成功或者失败。

 

如果我使用dingoapi的话,dingoapi可以既返回异常又返回json数据(如果不使用dingoapi,返回异常的话会返回一个异常的html页面)。

 

所以就可以用jquery的ajax的error回调函数来肯定操作失败的行为:

dataType:json,

error:function(error){

  alert($.parseJSON(error.responseText));    //parseJSON方法将json字符串转化为json对象

}

    这里是laravel控制器中的一个方法。

        这里是ajax的error回调函数

这里是浏览器的控制台

 


看完效果以后便知道为什么要用parseJSON将json字符串转化为json对象了,因为responseText的属性是一个json格式的字符串,但不是对象。

转化为对象以后变会输出错误消息。

第二个功能:

使用dingoapi的tranform

app\Http\Transformers下新建一个UserTransformer.php文件(这个Transformers文件夹也是新建的):

复制代码
<?php

namespace App\Http\Transformers;

use App\Models\User;
use League\Fractal\TransformerAbstract;

class UserTransformer extends TransformerAbstract
{

    protected $availableIncludes = [];
    protected $defaultIncludes = [];

    public function transform(User $item)
    {
        return [
                'id' => $item->id,
                'name' => $item->name,
                'sex' => $item->sex,
                'telphone' => $item->telphone,
                'car_company'=>isset($item->car->car_company) ? $item->car->car_company : '',
                'license_plate'=>isset($item->car->license_plate) ? $item->car->license_plate : '',
                'birthday' => $item->birthday,
                'created_at'=>(string)$item->created_at,
                'first_time'=>isset($item->car->first_time) ? $item->car->first_time : '',
                'integral'=>$item->integral,
        ];
    }

}
复制代码

 

这样定义以后,在控制中

 

复制代码

<?php


namespace App\Http\Controllers\Api;

use App\Models\User;

use App\Http\Transformers\UserTransformer;

class UserApiController extends BaseController  //这里继承BaseController

{

  public function users(){  

    $user->all();    //这里也可以写成一些where条件
    return $this->response->item($user, new UserTransformer);

  }

}


复制代码

 

这就会把$user里其他的字段全部过滤掉,这么写的话非常有规范性,控制器中就不用写太多的数据转化了。

当然如果非要在控制中实现过滤数组的话,可以使用以下常用函数:

array_filter($arr)  

参数是一个数组,实现过滤键值为空的数组元素

array_only($arr,$key) 参数是数组,只保留参数数组中的键,其余的全部过滤掉

array_except($arr,$key)参数是数组,除了参数$key数组以外的键,其余的全部过滤掉

 

当然,dingoapi的功能肯定不只这两个,还有很多,我会慢慢在使用中做笔记。

来自 http://www.cnblogs.com/zzdylan/p/6002503.html
 

dingoapi的安装:

我是在我的centos服务器上安装laravel和dingoapi的,首先确保电脑上有相关的依赖:composer。

1、在指定的目录下先安装laravel:laravel new api,用这个命令后文件夹里是已经有了vendor这个依赖的。

2、修改composer.json

 

"require": {
    "dingo/api": "1.0.*@dev"
}

3、执行composer update命令安装dingoapi

 

 

命令行下提示安装成功。

4、打开config/app.PHP

在providers中添加Dingo\Api\Provider\LaravelServiceProvider::class

运行php artisan vendor:publish --provider="Dingo\Api\Provider\LaravelServiceProvider"

运行成功后会生成api.php。

5、配置.env文件

加上API_PREFIX=api

其余全部是默认设置

6、访问域名,会看到返回信息。

7、路由中:

$api = app('Dingo\Api\Routing\Router');
$api->version('v1', function ($api) {
    $api->post('/register','App\Http\Controllers\MyController@register');
});

8、用postman测试:domain/api/register

来自 
http://blog.csdn.net/qq_32534341/article/details/51447494

普通分类: