README

基本Laravel API客户端，Eloquent风格。

安装

Composer

需要包

composer require mdelariva/api-model

并发布配置 Provider: MdelaRiva\ApiModel\Providers\ServiceProvider

php artisan vendor:publish

GIT

克隆仓库

git clone git@bitbucket.org:marianodelariva/api-model.git

并发布配置 Provider: MdelaRiva\ApiModel\Providers\ServiceProvider

php artisan vendor:publish

用法

1- 在.env和/或config/apimodel.php中填写配置

2- 从MdelaRiva\ApiModel\ApiModelAbstract扩展你的模型

<?php

namespace App\Models;

use MdelaRiva\ApiModel\ApiModelAbstract;

class Article extends ApiModelAbstract
{

}

3- 在你的控制器中使用你的模型，就像使用Eloquent一样

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use App\Models\Article;

class ArticleController extends Controller
{
	public function index()
	{
		// Find item
		$article = Article::find( 1 );
		$article = Article::findOrFail( 1 );
		
		// Update item
		$article->status = 2;
		$article->save();
		
		// Create item
		$article = new Article();
		$article->status = 2;
		$article->save();
		
		// Delete item
		$article->delete();
		Article::destroy( 1 );
		
		// Full List
		$articleList = Article::all();
		
		// Query List
		$articleList = Article::where( 'status', 2 )->orderBy( 'status' )->get();
		// Single item
		$article = Article::where( 'status', 2 )->orderBy( 'status', 'desc' )->first();
		
		// Query object
		$articleQuery = Article::query();
		$articleList = $articleQuery::where( 'status', 2 )->get();

	}
}

配置

config/apimodel.php中的可用选项

单个连接选项

认证

认证类型

有关认证类型的更多信息，请参阅Postman 文档。

节流限制元素

日志记录

日志文件保存在存储目录中的 logs 文件夹内，文件名模式如下：apimodel-{connection_name}.log。

记录的每个请求都具有使用的方法、URL、查询参数和日志类型。

有两种类型的日志

• requests：记录直接发出的 API 请求。
• cache：记录缓存的 API 请求。

分组连接选项

您可以定义一个分组连接，该连接将遍历单个连接列表。如果模型设置了分组连接，则每次实例化时将使用单个连接。

配置示例

<?php

return [

	'default' => env('APIMODEL_CONNECTION', 'default'),

   'connections' => [
        'connection_1' => [
            'url' => 'https://api.example.com/',
        ],
        'connection_2' => [
            'url' => 'https://api.example.com/',
        ],
        'connection_3' => [
            'url' => 'https://api.example.com/',
        ],
        'grouped_connection' => [
        	   'connections' => [
					'connection_1',
					'connection_2',
					'connection_3'
        	   ]
        ],
    ],

];

查询构建器驱动程序

此类包括用作查询构建器的方法，并定义将发送到 API 的请求参数。只要您构建一个扩展自 MdelaRiva\ApiModel\Drivers\QueryInterface 的驱动程序，就可以自由编写自己的驱动程序。

基本（默认）

API：https://bitbucket.org/marianodelariva/api-controller

命名空间：MdelaRiva\ApiModel\Drivers\Basic

- 允许的方法

- where

此方法允许您使用多个运算符，这些运算符将被转换为附加到参数名称的代码，并且远程API应理解。

示例

Article::where( 'status', '>=', 2 )
	->where( 'name', 'like', 'example%' )
	->whereIn( 'section', [3,4] )
	->orderBy( 'status', 'asc' )
	->get();

API调用参数: status_ge=2&name_ap=example&section[]=3&section[]=4&orderBy=status&orderByDir=asc.

Twitter - 推文搜索

API: https://developer.twitter.com/en/docs/tweets/search

命名空间: MdelaRiva\ApiModel\Drivers\Twitter\TweetsSearch

- 允许的方法

- where

此方法构建查询参数。

$operator参数不予考虑，而$field参数是Twitter运算符（完整列表）。与基本驱动程序不同，$value必须是字符串。

示例

TweetsSearch::where( 'lang', 'pt' )
	->where( 'query', 'Twitter Dev' )
	->fromDate( new \DateTime( '2016-04-22' ) )
	->groupBy( 'day' )
	->limit( 10 )
	->get();

API调用参数: query=Twitter Dev lang:pt&fromDate=201604220000&bucket=day&maxResults=10.

预构建驱动程序

Twitter - 推文搜索

• API文档
• 命名空间: MdelaRiva\ApiModel\Drivers\Twitter\TweetsSearch

YouTube数据API - 频道

• API文档
• 命名空间: MdelaRiva\ApiModel\Drivers\Youtube\Channel

YouTube数据API - 搜索

• API文档
• 命名空间: MdelaRiva\ApiModel\Drivers\Youtube\Search

缓存

config/apimodel.php中的enabled键是一个全局标志，用于启用/禁用缓存。如果为TRUE，则存储所有GET请求的响应。如果为FALSE，则不会存储任何响应。如果为null，则取决于每个请求或模型配置。

使用的驱动程序: file

用法

- 查询

用于存储特定的查询（全局标志必须为TRUE或null），并刷新它

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use App\Models\Article;

class ArticleController extends Controller
{
	public function index()
	{
		// Cache using default configuration
		$articleQuery = Article::cacheQuery();
		$articleList = $articleQuery::where( 'status', 2 )->orderBy( 'status' )->get();
		// Query inline
		$articleQuery = Article::cacheQuery()->where( 'status', 2 )->orderBy( 'status' )->get();
		
		// Cache using specific TTL (30 seconds)
		$articleQuery = Article::cacheQuery( FALSE, 30 );
		$articleList = $articleQuery::where( 'status', 2 )->orderBy( 'status' )->get();
		
		// Make request, refreshing cache
		$articleQuery = Article::cacheQuery( TRUE );
		$articleList = $articleQuery::where( 'status', 2 )->orderBy( 'status' )->get();

	}
}

- 清空

按模型清空

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use App\Models\Article;

class ArticleController extends Controller
{
	public function index()
	{
		// Flush all Article cache
		Article::cacheFlush();
	}
}

模型

可用方法

这是一个调用连接的方法列表

• all
• call
• get
• find
• findOrFail
• first
• firstOrNew
• pagination
• delete
• destroy
• save

配置

- 分页

定义分页时返回的项目数量。

<?php

namespace App\Models;

use MdelaRiva\ApiModel\ApiModelAbstract;

class Article extends ApiModelAbstract
{
    protected $perPage = 20;
}

- 连接

受保护的$connection属性（字符串）必须匹配上述apimodel配置文件中connection数组中的一个键。

<?php

namespace App\Models;

use MdelaRiva\ApiModel\ApiModelAbstract;

class Article extends ApiModelAbstract
{
	protected $connection = 'twitter';
}

- 端点

如果您的模型名称无法匹配API端点，您可以手动定义它

<?php

namespace App\Models;

use MdelaRiva\ApiModel\ApiModelAbstract;

class SomeEndpoint extends ApiModelAbstract
{
	protected $endpoint = 'endpoint';
}

- 驱动程序

手动设置驱动程序（这将覆盖apimodel文件配置）

<?php

namespace App\Models;

use MdelaRiva\ApiModel\ApiModelAbstract;

class SomeEndpoint extends ApiModelAbstract
{
	protected $driver = \MdelaRiva\ApiModel\Drivers\Youtube\Channel::class;
}

- 自定义调用

您可以为自己创建自定义调用的方法

<?php

namespace App\Models;

use MdelaRiva\ApiModel\ApiModelAbstract;

class Article extends ApiModelAbstract
{
	public static function test( $params )
   {
       return self::call( [ 'test' ], 'POST', $params );
   }
}

- 缓存

用于存储由模型执行的所有GET请求（全局缓存标志必须为TRUE或null），以及/或TTL（以秒为单位）

<?php

namespace App\Models;

use MdelaRiva\ApiModel\ApiModelAbstract;

class Article extends ApiModelAbstract
{
	public $cache = TRUE;
	protected $cacheTtl = 30;
}

预构建模型

Twitter - 用户

• API文档
• 命名空间: MdelaRiva\ApiModel\Models\Twitter\User

YouTube数据API - 频道

• API文档
• 命名空间: MdelaRiva\ApiModel\Models\Youtube\Channel

YouTube数据API - 搜索

• API文档
• 命名空间: MdelaRiva\ApiModel\Models\Youtube\Search

示例

Twitter集成

- 配置

<?php

return [

	'default' => env('APIMODEL_CONNECTION', 'default'),

   'connections' => [

		'twitter' => [
			'url' => 'https://api.twitter.com/',
			'version' => '1.1',
			'credentials' => [
				'useAuthorizationHeader' => TRUE,
				'grant_type' => 'client_credentials',
				'client_id' => env( 'APIMODEL_CLIENT_ID' ),
				'client_secret' => env( 'APIMODEL_CLIENT_SECRET' ),
			],
			'wrappers' => [
				'collection' => [
					'root' => 'results',
				],
			],
		],

	],

];

- 模型

使用手动调用

<?php

namespace App\Models;

use MdelaRiva\ApiModel\ApiModelAbstract;

class Twitter extends ApiModelAbstract
{
    protected $connection = 'twitter';

    public function __construct( array $attributes = array() )
    {
        parent::__construct( $attributes );
        $this->setEndpoint( '' );
    }

    public static function tweetsSearch( $query, $fromDate = null, $maxResults = 10 )
    {
        $parameters = [
            'query' => $query,
            'maxResults' => $maxResults,
            'fromDate' => $fromDate,
        ];

        return self::call( [ 'tweets/search/30day/testing.json' ], 'GET', $parameters );
    }

}

使用预构建模型

<?php

namespace App\Models;

use MdelaRiva\ApiModel\Models\Twitter\User as TwitterUser;

class User extends TwitterUser
{
	protected $connection = 'twitter';
}