README

OK SDK PHP是一个 PHP包装器，提供了一种更简单的方式使用OKSDK REST方法进行API调用。

需求

• PHP >= 5.4

Composer安装

使用Composer可以快速轻松地安装Intervention Image。

现在您的composer.json已自动更新，您可以将创建的vendor/autoload.php文件添加到PSR-4自动加载库中。

下一步是决定您是否要将APIOK SDK集成到Laravel框架中。如果您想使用Laravel库，请跳过以下步骤，继续阅读Laravel集成描述。

用法

APIOK SDK根本不需要Laravel或任何其他框架。如果您想直接使用它，只需像以下示例所示，要求composer自动加载文件以实例化图像对象即可。

// include composer autoload
require 'vendor/autoload.php';

// import the Alexchitoraga APIOK Class
use Alexchitoraga\Apiok\Apiok;

// create an APIOK instance with custom app configs
$apiok = new Apiok([
    'application_key' => '***',
    'session_key' => '***',
    'access_token' => '***',
    'secret_key' => '***',
]);

// Call OKSDK API method
// Methods must be converted by next principle:
// users.getInfo => usersGetInfo
// messagesV2.sendGameInvite => messagev2SendGameInvite
$apiok->usersGetInfo($params);

Laravel集成

APIOK对Laravel有可选支持，并提供服务提供者和外观以便于集成。vendor/autoload.php由Laravel包含，因此您无需手动要求或自动加载。只需查看下面的说明。

安装APIOK后，打开您的Laravel配置文件config/app.php，并添加以下行。

在$providers数组中添加此包的服务提供者。

Alexchitoraga\Apiok\ApiokServiceProvider::class

将此包的外观添加到$aliases数组中。

'Apiok' => Alexchitoraga\Apiok\Facades\Apiok::class

现在Apiok类将被Laravel自动加载。

配置

APIOK没有默认配置，因为每个OK应用程序都有自己的配置。要设置配置，您必须在config/services.php文件中添加新的服务。

'apiok' => {
    'application_key' => env('APPLICATION_KEY'),
    'session_key' => env('SESSION_KEY'),
    'access_token' => env('ACCESS_TOKEN'),
    'secret_key' => env('SECRET_KEY'),
],

测试

测试存储在/tests文件夹中。有两个测试被禁用。要运行它们，您必须修改phpunit.xml中的php常量，配置来自您的应用程序。您还必须使用关键字“test”作为这两个测试的前缀。