Skip to content

Repository files navigation

uapi-sdk-php

Banner

PHPDocs

Note

所有接口的 PHP 示例都可以在 UApi 的接口文档页面,向下滚动至 快速启动 区块后直接复制。

快速开始

composer require AxT-Team/uapi-sdk-php
<?phprequire'vendor/autoload.php';
$client = newUapi\Client('https://uapis.cn', 'YOUR_API_KEY');
$result = $client->social()->getSocialQqUserinfo(['qq' => '10001']);
var_dump($result);

特性

现在你不再需要反反复复的查阅文档了。

只需在 IDE 中键入 $client->,所有核心模块——如 social()game()image()——即刻同步展现。进一步输入即可直接定位到 getSocialQqUserinfo 这样的具体方法,其名称与文档的 operationId 严格保持一致,确保了开发过程的直观与高效。

所有方法签名只接受真实且必需的参数。当你在构建请求时,IDE 会即时提示 qqusername 等键名,这彻底杜绝了在关联数组中因键名拼写错误而导致的运行时错误。

针对 401、404、429 等标准 HTTP 响应,SDK 已将其统一映射为具名的异常类型。这些异常均附带 codestatusdetails 等关键上下文信息,确保你在日志中能第一时间准确、快速地诊断问题。

HTTP 层基于 Guzzle,构造函数会自动设置 Base URL、追加 Authorization 头并关闭 http_errors,方便你直接读取 JSON/字节响应;需要更细致的超时或代理策略时,可以按需扩展这段初始化逻辑。

如果你需要查看字段细节或内部逻辑,仓库中的 ./internal 目录同步保留了由 openapi-generator 生成的完整结构体,随时可供参考。

错误模型概览

HTTP 状态码SDK 错误类型附加信息
401/403UnauthorizedErrorcodestatus
404NotFoundError / NoMatchErrorcodestatus
400InvalidParameterError / InvalidParamsErrorcodestatusdetails
429ServiceBusyErrorcodestatusretry_after_seconds
5xxInternalServerErrorError / ApiErrorErrorcodestatusdetails
其他 4xxUapiErrorcodestatusdetails

其他 SDK

语言仓库地址
Gohttps://github.com/AxT-Team/uapi-sdk-go
Pythonhttps://github.com/AxT-Team/uapi-sdk-python
TypeScripthttps://github.com/AxT-Team/uapi-sdk-typescript
Browser (TypeScript/JavaScript)https://github.com/AxT-Team/uapi-browser-sdk
Javahttps://github.com/AxT-Team/uapi-sdk-java
PHP(当前)https://github.com/AxT-Team/uapi-sdk-php
C#https://github.com/AxT-Team/uapi-sdk-csharp
C++https://github.com/AxT-Team/uapi-sdk-cpp
Rusthttps://github.com/AxT-Team/uapi-sdk-rust

文档

访问 UApi文档首页 并选择任意接口,向下滚动到 快速启动 区块即可看到最新的 PHP 示例代码。

About

Official PHP SDK for UAPI / uapis.cn — typed PHP wrapper around 100+ free public endpoints

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages