README

UpDown.io 包用于 Laravel 5

安装

您可以通过 composer 安装此包

composer require biscolab/laravel-updown:^1.0

Laravel 5.5（或更高版本）使用包自动发现，因此不需要您手动添加 Service Provider，但如果您不使用自动发现，则必须将 UpDownServiceProvider 注册到 config/app.php 中：服务 provider 必须在 config/app.php 中注册

'providers' => [
    ...
    Biscolab\LaravelUpDown\UpDownServiceProvider::class,
];

您可以使用 facade 以缩短代码。将 "UpDown" 添加到您的别名

'aliases' => [
    ...
    'UpDown' => Biscolab\LaravelUpDown\Facades\UpDown::class,
];

配置

添加您的 API 密钥

打开 .env 文件并设置 UPDOWN_API_KEY

UPDOWN_API_KEY=<YOUR_UPDOWN_API_KEY>

现在刷新 Laravel 缓存

php artisan config:cache

您还可以使用以下命令创建 config/updown.php 配置文件：

php artisan vendor:publish --provider="Biscolab\LaravelUpDown\UpDownServiceProvider"

打开 config/updown.php 配置文件并设置 api_key，如果您不想在 .env 文件中设置它

return [
    'api_key' => env('UPDOWN_API_KEY', ''),       
];

关于 updown.io 服务的更多信息这里

如何使用

此包使用 biscolab/updown-php-sdk。首先，我建议您熟悉这里和 updown.io 官方文档

辅助工具

updown();

updown() 辅助函数返回一个包含使用您的 `UPDOWN_API_KEY` 创建的 UpDown 对象的 UpDownBuilder 实例

使用对象

要调用对象，只需调用同名的函数

// List all Checks: returns a Checks collection
// Empty Check instance
$checks = updown()->Check()->all();

// Check instance initialized with "xxxx" token
$check = updown()->Check("xxxx");

// Check instance initialized with $params array
// using Biscolab\UpDown\Fields\CheckFields
$params = [
    CheckFields::URL => 'https://insert.your-url.to/check'
];
$check = updown()->Check($params);

有关 Check 类及其所有方法的更多信息这里

对于 Node、WebHook、Event 对象，遵循相同的模式。

测试

composer test

biscolab / laravel-updown

维护者

详细信息

README

安装

配置

添加您的 API 密钥

如何使用

辅助工具

使用对象

测试