README

此库为UptimeRobot API提供了一个API客户端。

安装

composer require wizbii/uptimerobot-php-sdk

使用

基本

$apiKey = "abcd"; // replace it with your own key
$client = new \Wizbii\UptimeRobotPHPSDK\UptimeRobotHttpClient($apiKey);
$monitors = $client->getAllMonitors();

Symfony

# .env
UPTIMEROBOT_APIKEY=abcd

# config/services.yaml
parameters:
    uptimerobot.apikey: '%env(UPTIMEROBOT_APIKEY)%'
    env(UPTIMEROBOT_APIKEY): 'abcd'

services:
    Wizbii\UptimeRobotPHPSDK\UptimeRobotHttpClient:
        arguments:
              $apiKey: '%uptimerobot.apikey%'

# any services like a controller
namespace App\Controller;

use Wizbii\UptimeRobotPHPSDK\UptimeRobotHttpClient;

class MyController
{
    public function __construct(
        private readonly UptimeRobotHttpClient $uptimeRobotHttpClient
    ) {}
    
    public function myFunction(): void
    {
        $monitors = $this->uptimeRobotHttpClient->getAllMonitors();
        // do something
    }
}

API方法

所有API方法均在Wizbii\UptimeRobotPHPSDK\UptimeRobotHttpClient中进行了文档化和强类型定义。

贡献

步骤

• 克隆或分支仓库
• 创建分支
• 进行开发
• 使用composer dev:checks检查一切是否正常
• 创建合并请求