jaybizzle/deploybot-api

DeployBot API 的简单 PHP 封装

v2.1.0 2019-07-06 08:01 UTC

This package is auto-updated.

Last update: 2024-09-09 19:04:20 UTC


README

Build Status StyleCI Total Downloads

安装

"jaybizzle/deploybot-api": "2.*" 添加到您的 composer.json 文件中。

旧版本

如果您需要与旧版本的 PHP 或 Guzzle 一起使用,请查看 1.0 分支

用法

您可以在此处阅读官方 DeployBot API 文档 - http://deploybot.com/api/

所有 DeployBot API 端点都可以通过在名称前加 get 来调用,例如:

use Jaybizzle\DeployBot;

$db = new DeployBot('YOUR_API_KEY', 'YOUR_ACCOUNT_NAME');

// get all users
$users = $db->getUsers();

// get a specific user
$user = $db->getUsers(324);

一些 DeployBot API 端点可以接受查询字符串参数,例如 limit 用于限制返回的结果数。以上面的用户示例,我们可以这样简单地做...

$users = $db->limit(10)->getUsers();

这些也可以串联使用...

$users = $db->limit(10)->after(324)->getUsers();

更多示例...

//  list deployments for environment and limit results
$deployments = $db->environmentId(3452)->limit(10)->getDeployments();

// list repositories and limit results
$repositories = $db->limit(20)->getRepositories();

注意:查询参数在 DeployBot API 文档中列为 snake_case,但我们是使用 camelCase 方法来访问它们的,因此所有方法调用都遵循一致的命名约定。