README

一个轻量级的SDK，用于开发REST API客户端

安装

使用Composer进行安装

composer require filippo-toso/api-sdk

它是如何工作的？

最好的方法是先从一个示例开始。让我们为Windy.com API构建一个SDK。

首先我们构建主类

use FilippoToso\Api\Sdk\Sdk;

class Windy extends Sdk
{
    public function list(): ListEndpoint
    {
        return new ListEndpoint($this);
    }
}

Windy公开了一个list()方法，实现了https://api.windy.com/webcams/docs#/list调用。你可以实现你想要的任意数量的端点（例如map）。

然后我们编写调用端点的代码

use FilippoToso\Api\Sdk\Endpoint;
use FilippoToso\Api\Sdk\Support\Response;

class ListEndpoint extends Endpoint
{
    public function nearby($latitude, $longitude, $radius = 10): Response
    {
        return $this->get('/list/nearby=' . $latitude . ',' . $longitude . ',' . $radius . '?' . http_build_query($this->params([
            'show' => 'webcams:location,image',
        ])));
    }
}

ListEndpoint公开了nearby()方法。一个端点类可以公开你需要的任意多的方法（例如，每个REST调用一个）。

最后，我们调用服务

use FilippoToso\Api\Sdk\Support\Options;

include(__DIR__ . '/../vendor/autoload.php');

include(__DIR__ . '/ListEndpoint.php');
include(__DIR__ . '/Windy.php');

$options = new Options([
    'uri' => 'https://api.windy.com/api/webcams/v2',
    'headers' => [
        'x-windy-key' => '...',
        'Content-Type' => 'application/json',
        'Accept' => 'application/json',
    ],
]);

$windy = new Windy($options);

$response = $windy->list()->nearby(45.9035644, 13.3038818, 10);

print_r($response->body());

Options类允许你指定多个选项（例如，生产与开发URL）。请查看源代码获取所有可用选项的更多信息。

就这样。一个灵活且干净的API SDK实现。

灵感来源

这个SDK深受以下文章系列的影响

https://madewithlove.com/blog/software-engineering/building-an-sdk-with-php-part-1/