README

SDK 安装

SDK 依赖于 Composer 来管理其依赖项。

要安装 SDK 并将其添加到现有 composer.json 文件作为依赖项

composer require "speakeasy-api/speakeasy-client-sdk-php"

SDK 示例用法

示例

declare(strict_types=1);

require 'vendor/autoload.php';

use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Operations;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;

$security = new Shared\Security(
    apiKey: '<YOUR_API_KEY_HERE>',
);

$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();

$request = new Operations\GetApisRequest();

$response = $sdk->apis->getApis(
    request: $request
);

if ($response->apis !== null) {
    // handle response
}

可用的资源和操作

错误处理

在此SDK中处理错误应大致符合您的预期。所有操作返回一个响应对象或抛出异常。

默认情况下，API错误将引发一个Errorors\SDKException异常，该异常具有以下属性

当为操作指定自定义错误响应时，SDK也可能抛出相关的异常。您可以通过SDK文档中的相应错误表了解每个操作可能的异常类型。例如，deleteApi方法抛出以下异常

示例

declare(strict_types=1);

require 'vendor/autoload.php';

use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Operations;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;

$security = new Shared\Security(
    apiKey: '<YOUR_API_KEY_HERE>',
);

$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();

try {
    $request = new Operations\DeleteApiRequest(
        apiID: '<id>',
        versionID: '<id>',
    );

    $response = $sdk->apis->deleteApi(
        request: $request
    );

    if ($response->statusCode === 200) {
        // handle response
    }
} catch (Errorors\ErrorThrowable $e) {
    // handle $e->$container data
    throw $e;
} catch (Errorors\SDKException $e) {
    // handle default exception
    throw $e;
}

服务器选择

服务器选择

按名称选择服务器

您可以通过在初始化SDK客户端实例时传递一个服务器名称，来全局覆盖默认服务器。然后所选服务器将用作使用它的操作的默认服务器。此表列出了与可用服务器关联的名称

按客户端覆盖服务器URL

默认服务器也可以通过在初始化SDK客户端实例时传递URL来全局覆盖，例如

摘要

Speakeasy API：Speakeasy API允许团队使用他们的API管理常见操作

有关API的更多信息： Speakeasy平台文档

目录

• SDK 安装
• SDK 示例用法
• 可用的资源和操作
• 错误处理
• 服务器选择

成熟度

此SDK处于beta版本，版本之间可能存在破坏性更改，而无需进行主要版本更新。因此，我们建议将使用限制在特定包版本上。这样，您可以每次安装相同的版本，除非您有意寻找最新版本。

贡献

虽然我们重视对此SDK的开源贡献，但此库是通过程序生成的。请随意打开一个PR或一个Github问题作为概念证明，我们将尽力将其包含在未来的版本中！

SDK由Speakeasy创建