README

CakePHP 3 的 Github Webservice (API)

安装

使用 Composer

composer require muffin/github:dev-master

然后您需要加载插件。您可以使用以下 shell 命令

bin/cake plugin load Muffin/Github

或者，手动将以下语句添加到 boostrap.php 文件中

Plugin::load('Muffin/Github');

使用方法

在您的 app.php 文件中，像其他配置一样配置您的 github 服务，通过向配置数组中添加新元素

    'Webservices' => [
        'github' => [
            'className' => 'Muffin\Webservice\Connection',
            'service' => 'Muffin/Github.Github',
        ]
    ]

或者，例如使用令牌（并使用完全命名空间驱动程序）

    'Webservices' => [
        'github' => [
            'className' => 'Muffin\Webservice\Connection',
            'service' => 'Muffin\Github\Webservice\Driver\Github',
            'token' => env('GITHUB_TOKEN'),
        ]
    ]

或者使用您的用户名/密码组合

    'Webservices' => [
        'github' => [
            'className' => 'Muffin\Webservice\Connection',
            'service' => 'Muffin/Github.Github',
            'username' => env('GITHUB_USERNAME'),
            'password' => env('GITHUB_PASSWORD'),
        ]
    ]

或者使用您的客户端 ID 和密钥

    'Webservices' => [
        'github' => [
            'className' => 'Muffin\Webservice\Connection',
            'service' => 'Muffin/Github.Github',
            'clientId' => env('GITHUB_CLIENT_ID'),
            'secret' => env('GITHUB_SECRET'),
        ]
    ]

如果您尚未在 bootstrap.php 文件中加载 web 服务，则还需要加载它

ConnectionManager::config(Configure::consume('Webservices'));

现在，您可以从任何地方像这样调用 web 服务

$connection = ConnectionManager:get('github');
$repo = $connection->api('repo')->show('usemuffin', 'github');

补丁与特性

• 分支
• 修改、修复
• 测试 - 这很重要，所以不要不小心破坏它
• 提交 - 不要修改许可证、todo、版本等。（如果您确实更改了任何，请将它们放入我可以在拉取时忽略的单独提交中）
• 拉取请求 - 主题分支的加分项

为了确保您的 PR 被考虑纳入上游，您必须遵循 CakePHP 编码标准。

错误与反馈

http://github.com/usemuffin/github/issues

许可证

版权（c）2015，[Use Muffin] 并在 MIT 许可证 下许可。