praftr / wimi-api-client

v1.0.0 2023-09-13 15:43 UTC

This package is auto-updated.

Last update: 2024-09-13 18:32:28 UTC


README

此PHP包是Wimi API的客户端。请参阅官方API文档

每个目标实现都是自动生成的,请参阅下方的“生成请求类”部分了解详细信息。

要求

  • PHP 8.1及以上

安装

composer require praftr/wimi-api-client

使用

<?php

require 'vendor/autoload.php';

use Praftr\WimiApiClient\ApiClient;
use Praftr\WimiApiClient\Request\Main\Account\GetProjectsRequest;

$accountId = 1;
$userId = 1;

$apiClient = new ApiClient('account_name', 'username', 'password', 'app_token');
$apiClient->handle(new GetProjectsRequest($accountId, $userId)); // ['projects' => ['project_id: 1, ...

可选地,您可以使用任何实现psr/http-client的HTTP客户端来覆盖。

例如,使用Symfony HttpClient组件

composer require symfony/http-client
<?php

require 'vendor/autoload.php';

use Symfony\Component\HttpClient\Psr18Client;
use Praftr\WimiApiClient\ApiClient;

$httpClient = new Psr18Client();
$apiClient = new ApiClient('account_name', 'username', 'password', 'app_token', $httpClient);

默认是Guzzle

生成请求类

Request目录中的每个类(除Abstract和Interface外)都是通过抓取和解析在线API文档自动生成的。

生成类的代码可以在src/Generator/下找到。

欢迎测试它,并在发现API文档中的任何更新时提交PR。

首先,删除生成的请求类

php bin/generate_requests.php

测试

php ./vendor/bin/phpunit

代码分析

php tools/php-cs-fixer/vendor/bin/php-cs-fixer --config=.php-cs-fixer.php.dist --allow-risky=yes fix

许可

本软件包在MIT许可(MIT)下提供。请参阅许可文件以获取更多信息。