Skip to content

AxT-Team/uapi-sdk-rust

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

uapi-sdk-rust

Banner

Rust Docs crates.io docs.rs

Note

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

快速开始

cargo add uapi-sdk-rust
use _::{Client, Result};

#[tokio::main]
async fn main() -> Result<()> {
    let client = Client::new("<TOKEN>");
    let result = client.social().get_social_qq_userinfo("10001").await?;
    println!("{result:?}");
    Ok(())
}

特性

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

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

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

针对 401、404、429 等标准 HTTP 响应,SDK 已将其统一映射为具名的错误类型(Error::AuthenticationErrorError::NotFoundError::RateLimitError 等)。这些错误均附带 status()request_id()details() 等关键上下文信息,确保你在日志中能第一时间准确、快速地诊断问题。

Client::builder() / Client::new() / Client::from_env() 允许你在保持默认 15 秒超时与 Authorization 头的同时,自由覆盖 Base URL、Token、代理乃至注入自定义的 reqwest::Client

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

模型

uapi::models 直接 re-export 了 internal/src/models 中的所有结构体,因此你可以在 IDE 中获得与 OpenAPI 保持一致的强类型定义。例如:

use uapi::{Client, models::GetNetworkIpinfo200Response};

所有模型都派生了 Serialize / Deserialize,可以安全地持久化或在应用调用间传递。

错误模型概览

HTTP 状态码 SDK 错误类型 附加信息
401/403 Error::AuthenticationError statusrequest_id
404 Error::NotFound statusrequest_id
400 Error::ValidationError statusdetailsrequest_id
429 Error::RateLimitError statusretry_after_secondsrequest_id
5xx Error::ServerError statusrequest_id
其他 4xx/5xx Error::ApiError codestatusdetailsrequest_id

其他 SDK

语言 仓库地址
Go https://github.com/AxT-Team/uapi-sdk-go
Python https://github.com/AxT-Team/uapi-sdk-python
TypeScript https://github.com/AxT-Team/uapi-sdk-typescript
Browser (TypeScript/JavaScript) https://github.com/AxT-Team/uapi-browser-sdk
Java https://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
Rust(当前) https://github.com/AxT-Team/uapi-sdk-rust

文档

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