Dingo Api 1.0在laravel5.2中的简单应用

2022-02-20 14:38:50

`Dingo Api`是为基于`laravel`的开发提供了一系列工具集，这些工具集可以帮助开发者快速构建`API`。`Dingo Api`最新的版本是`2.0.0-alpha1`，这个版本需要`php7.0`以上的`php`版本的支撑，笔者这里以`Dingo Api 1.0`为例简单介绍其在laravel5.2中的应用。

安装Dingo Api

在composer.json中的require中添加"dingo/api": "1.0.*@dev"

composer.json
执行composer update

composer update

配置Dingo Api

在config/app.php的providers中增加Dingo\Api\Provider\LaravelServiceProvider::class,
执行php artisan vendor:publish --provider="Dingo\Api\Provider\LaravelServiceProvider"以生成config下配置文件

vendor:publish
在config/app.php的aliases中添加'Api' => Dingo\Api\Facade\API::class,
配置config/api.php
需要配置的内容如下：

'standardsTree' => env('API_STANDARDS_TREE', 'vnd'), // 项目需要能被公开访问

'subtype' => env('API_SUBTYPE', 'blog'), // 根据项目名称配置

'prefix' => env('API_PREFIX', 'api'), // 可以根据需求去设置 这里设置成api

'name' => env('API_NAME', 'Blog Api'), // 根据项目设置

'debug' => env('API_DEBUG', true), // 开启调试便于开发 上线后关闭之

创建API路由

创建App\Http\Controllers\Api\V1\UserController.php

创建控制器
创建API路由器

// 在app/Http/routes.php中增加
$api = app('Dingo\Api\Routing\Router');

创建以版本为单位的路由组

// 在app/Http/routes.php中增加
$api->version('v1', function ($api) {
    $api->get('user/{id}', ['as' => 'user.show', 'uses' => 'App\Http\Controllers\Api\V1\UserController@show']); // 注意此处controller要写完整命名空间
});

生成URL

// 在app/Http/routes.php中增加
app('Dingo\Api\Routing\UrlGenerator')->version('v1')->route('user.show', 'id');

最终代码概览

// 在app/Http/routes.php中增加
$api = app('Dingo\Api\Routing\Router');
$api->version('v1', function ($api) {
    $api->get('user/{id}', ['as' => 'user.show', 'uses' => 'App\Http\Controllers\Api\V1\UserController@show']); // 注意此处controller要写完整命名空间
});
app('Dingo\Api\Routing\UrlGenerator')->version('v1')->route('user.show', 'id');

在控制台查看路由

查看路由

创建API并访问

完善App\Http\Controllers\Api\V1\UserController
添加代码如下：

<?php

namespace App\Http\Controllers\Api\V1;

use App\Http\Controllers\Controller;
// 这里可以去掉没用的内容
use App\User; // 引用模型

class UserController extends Controller
{
    public function show($id) // 接口方法
    {
        return User::findOrFail($id);
    }
}

访问接口

访问接口

响应构建器

通过响应构建器可以构建更多自定义响应。

创建基类

创建基类
填充基类内容
具体代码如下：

<?php

namespace App\Http\Controllers\Api\V1;

// 自动生成的内容可以去掉
use Dingo\Api\Routing\Helpers; // trait
use Illuminate\Routing\Controller; // 增加

class BaseController extends Controller
{
    use Helpers;
}

继承基类
修改App\Http\Controllers\Api\V1\UserController为：

<?php

namespace App\Http\Controllers\Api\V1;

use App\Http\Controllers\Api\V1\BaseController; // 此处有调整

use App\User; // 引用模型

class UserController extends BaseController // 此处有调整
{
    public function show($id) // 接口方法
    {
        return User::findOrFail($id);
    }
}

数组响应
修改接口代码为：

public function show($id) // 接口方法
{
    $user = User::findOrFail($id);
    return $this->response->array($user->toArray());
}

增加一个获取全部用户数据的接口

修改路由

$api = app('Dingo\Api\Routing\Router');
$api->version('v1', function ($api) {
    $api->get('user/{id}', ['as' => 'user.show', 'uses' => 'App\Http\Controllers\Api\V1\UserController@show']); // 注意此处controller要写完整命名空间
    $api->get('user', ['as' => 'user.index', 'uses' => 'App\Http\Controllers\Api\V1\UserController@index']); // 注意此处controller要写完整命名空间 增加行
});
app('Dingo\Api\Routing\UrlGenerator')->version('v1')->route('user.show', 'id');
app('Dingo\Api\Routing\UrlGenerator')->version('v1')->route('user.index'); // 增加行

增加接口
在App\Http\Controllers\Api\V1\UserController增加方法：

public function index()
{
    return User::all();
}

user.index

数组响应
修改App\Http\Controllers\Api\V1\UserController的index方法：

public function index()
{
    $users = User::all();
    return $this->response->array($users->toArray());
}

数组响应

构建转换器

转换器用于对数据进行过滤和转化用以提供更加人性化的数据。

添加App\Transformers\Api\V1\UserTransformer.php
具体代码如下:

<?php

namespace App\Transformers\Api\V1;

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

class UserTransformer extends TransformerAbstract
{
    public function transform(User $user)
    {
        return [
            'name' => $user->name,
            'email' => $user->email,
            'created_at' => date('Y-m-d', strtotime($user->created_at))
        ];
    }
}

使用转换器
修改App\Http\Controllers\Api\V1\UserController：

<?php

namespace App\Http\Controllers\Api\V1;

use App\Http\Controllers\Api\V1\BaseController;
use App\Transformers\Api\V1\UserTransformer; // 增加行

use App\User; // 引用模型

class UserController extends BaseController
{

    public function index()
    {
        $users = User::all();
        return $this->response->array($users->toArray());
    }

    public function show($id) // 接口方法
    {
        $user = User::findOrFail($id);
        return $this->response->item($user, new UserTransformer); //修改
    }
}

transformer user.show

实现分页

执行php artisan make:seeder UsersTableSeeder

make:seeder
修改database\seeds\UsersTableSeeder.php

<?php

use Illuminate\Database\Seeder;

class UsersTableSeeder extends Seeder
{
    /**
     * Run the database seeds.
     *
     * @return void
     */
    public function run()
    {
        factory(App\User::class, 50)->create(); // 增加一行
    }
}

执行php artisan db:seed --class=UsersTableSeeder

db:seed

users
修改App\Http\Controllers\Api\V1\UserController的index方法：

public function index()
{
    $users = User::paginate(8);
    return $this->response->paginator($users, new UserTransformer);
}

paginate user.index

更多响应

指定信息和状态码的错误响应

public function index()
{
    /* $users = User::paginate(8);
    return $this->response->paginator($users, new UserTransformer); */
    return $this->response->error('This is an error.', 404);
}

指定信息和状态码的错误响应

未找到错误响应

public function index()
{
    /* $users = User::paginate(8);
    return $this->response->paginator($users, new UserTransformer); */
    return $this->response->errorNotFound();
}

未找到错误响应

坏请求错误响应

public function index()
{
    /* $users = User::paginate(8);
    return $this->response->paginator($users, new UserTransformer); */
    return $this->response->errorBadRequest();
}

坏请求错误响应

禁止访问错误响应

public function index()
{
    /* $users = User::paginate(8);
    return $this->response->paginator($users, new UserTransformer); */
    return $this->response->errorForbidden();
}

禁止访问错误响应

内部错误错误响应

public function index()
{
    /* $users = User::paginate(8);
    return $this->response->paginator($users, new UserTransformer); */
    return $this->response->errorInternal();
}

内部错误错误响应

未认证错误响应

public function index()
{
    /* $users = User::paginate(8);
    return $this->response->paginator($users, new UserTransformer); */
    return $this->response->errorUnauthorized();
}

未认证错误响应

添加响应头

public function show($id) // 接口方法
{
    $user = User::findOrFail($id);
    return $this->response->item($user, new UserTransformer)->withHeader('author', 'stone');
}

添加响应头

添加元数据

public function show($id) // 接口方法
{
    $user = User::findOrFail($id);
    return $this->response->item($user, new UserTransformer)->addMeta('author', 'stone');
}

添加元数据

public function show($id) // 接口方法
{
    $user = User::findOrFail($id);
    return $this->response->item($user, new UserTransformer)->setMeta(['author' => 'stone', 'date' => date('Y-m-d')]);
}

添加多个元数据

设置响应状态码

public function show($id) // 接口方法
{
    $user = User::findOrFail($id);
    return $this->response->item($user, new UserTransformer)->setStatusCode(202);
}

设置响应状态码

为接口增加权限控制

这一步需要提供oAuth的支持，可参考oAuth2.0在laravel5.2中的简单应用

在路由定义上加入oAuth中间件

$api->version('v1', ['middleware' => 'oauth'], function ($api) { // 加上中间件
    $api->get('user/{id}', ['as' => 'user.show', 'uses' => 'App\Http\Controllers\Api\V1\UserController@show']); // 注意此处controller要写完整命名空间
    $api->get('user', ['as' => 'user.index', 'uses' => 'App\Http\Controllers\Api\V1\UserController@index']); // 注意此处controller要写完整命名空间
});

获取access_token
创建可以通过http://www.test.com/test.php访问的脚本，内容如下：

function post($url, $param){
    $oCurl = curl_init();
    $aPOST = [];
    foreach($param as $key=>$val){
        $aPOST[] = $key.'='.urlencode($val);
    }
    $strPOST =  join('&', $aPOST);
    curl_setopt($oCurl, CURLOPT_URL, $url);
    curl_setopt($oCurl, CURLOPT_RETURNTRANSFER, 1 );
    curl_setopt($oCurl, CURLOPT_POST,true);
    curl_setopt($oCurl, CURLOPT_POSTFIELDS,$strPOST);
    $sContent = curl_exec($oCurl);
    $aStatus = curl_getinfo($oCurl);
    curl_close($oCurl);
    if(200 == intval($aStatus['http_code'])){
        return $sContent;
    }else{
        return false;
    }
}

$server = 'http://localhost:8000/oauth/access_token';
$params = [
    'grant_type' => 'password',
    'username' => 'admin@admin.com',
    'password' => '123456',
    'client_id' => 'shy7jf8fa93d59c45502c0ae8chj76s',
    'client_secret' => 'bc7f6f8fa93d59c45502c0ae8c4a95d',
];
echo post($server, $params);