README

安装

composer require cao-jiayuan/laravel-api[:dev-master]

服务提供者

• Laravel CaoJiayuan\LaravelApi\LaravelApiServiceProvider
• Lumen CaoJiayuan\LaravelApi\LumenApiServiceProvider

使用方法

1. 异常渲染

• 特质 : CaoJiayuan/LaravelApi/Foundation/Exceptions/Traits/ExceptionRenderer.php
• 使用

<?php

namespace App\Exceptions;
//......
use CaoJiayuan\LaravelApi\Foundation\Exceptions\Traits\ExceptionRenderer;
use Exception;
use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
//......

class Handler extends ExceptionHandler
{
    use ExceptionRenderer;
    //......
    public function render($request, Exception $exception)
    {
        return $this->renderException($request, $exception);
    }
}

2. Eloquent 管道查询

• 特质 CaoJiayuan\LaravelApi\Database\Eloquent\Helpers\Pipelineable

• 使用方法

<?php
namespace App;

use CaoJiayuan\LaravelApi\Database\Eloquent\Helpers\Pipelineable;
use Illuminate\Database\Eloquent\Model;

class Foo extends Model {
    
    use Pipelineable;
    
    public function relate() {
        return $this->belongsTo(App\Bar::class);
    }
}

\App\Foo::pipeline('with:relate|select:id,name');//equals \App\Foo::with('relate')->select(['id','name'])->get();
\App\Foo::join('baz', 'foo_id', '=', 'baz_id')
          ->pipeline('with:relate|select:id,name,baz.title as baz|get|pluck:name|random');

3. 模拟数据生成器

使用给定的模板（受Mock.js启发），与fzaninotto/Faker配合使用

使用方法

template = [
    'key|rule1[:params][|rule2[:params]]' [=> 'value']
]
dummy(template) array|mixed
dummy_pager(total, template [,page=1] [,perPage=25]) LengthAwarePaginator

示例

<?php

dummy([
   'id' => 1,
   'name|name',
   'address|address',
   'data|list:2' => [
        'id|1+1',   
        'name|name',   
    ]
]);

结果

{
    "id":1,
    "name":"Mrs. Bulah Hilll MD",
    "address":"445 Hudson Isle\nJunehaven, NM 74631",
    "data":[
        {"id":1,"name":"Sophie Kris"},
        {"id":2,"name":"Cooper Thompson"}
    ]
}

规则

• list[:size=20] 生成具有给定模板值的数组，别名为 l:size

• increase[:step=1,base=1] 生成从 base 开始的自动增加 step 的数字，别名为 base+step

• date[:format=Y-m-d H:i:s,now=time()] 生成带有格式的日期时间字符串

• randDate[:start,end='now',format='Y-m-d H:i:s'] 生成介于 start 和 end 之间的随机日期时间字符串

• rand[:min,max,value=null] 生成随机值，例如

   <?php
    dummy('rand|1,100');// return random number between 1 and 100
    dummy('rand|true,false');
    dummy([
      'data|list:10|rand:1,5' => [// working with pipeline, generate 10 items, randomly take 1-5 item[s]
           'id|1+1',   
          'name|name',
       ]
    ]);

• pick[:num=1] 从值中选择 num 个项目，如果 num = 1，则返回单个项目

• from 返回来自给定值的数

• db[:table,limit=null] 使用给定值作为回调从数据库中获取结果

   <?php
    dummy([
      'data1|db:users' => function(\Illuminate\Database\Query\Builder $builder) {
            /// database query
          $builder->select(['id', 'name']);
          /// ......
       },
       'data2|db:articles,2', /// randomly take 2 rows from table articles 
       'data3|db:connection1.articles,2', /// specified connection
       'data4|db:articles,10|pick:2' /// working with pipeline
    ]);

4. 辅助工具

请求辅助工具

• 特质 CaoJiayuan\LaravelApi\Http\Request\RequestHelper
• 方法 getValidatedData(array $rules, array $messages = [], array $customAttributes = [])

<?php
namespace App\Http\Controllers;

use CaoJiayuan\LaravelApi\Http\Request\RequestHelper;

class FooController extends Controller
{
    use RequestHelper;
    //
    
    public function post(){
        $data = $this->getValidatedData([
            'name' => 'required', // Key => Rule,
            'foo', //Only key [default null]
            'bar' => ['required'/* or null*/, 1], // // Key => [Rule, default],
            'baz' => ['required'/* or null*/, function($value){
                return $value + 1;
            }] // Key => [Rule, resolver],
        ], ['name.required' => '......'], ['foo' => '-_-!!!']);
    }
}