Skip to main content

Idiomatic UAPI SDK for Python

Project description

uapi-sdk-python

Banner

Python Docs PyPI

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

快速开始

pip install uapi-sdk-python
from uapi import UapiClient

client = UapiClient("https://uapis.cn/api/v1")
result = client.social.get_social_qq_userinfo(qq="10001")
print(result)

特性

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

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

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

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

UapiClient(base_url, token, timeout) 默认使用 httpx 并自动追加 Authorization 头;需要切换环境或调整超时时,只要改一次构造参数即可。

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

错误模型概览

HTTP 状态码 SDK 错误类型 附加信息
401/403 UnauthorizedError codestatus
404 NotFoundError / NoMatchError codestatus
400 InvalidParameterError / InvalidParamsError codestatusdetails
429 ServiceBusyError codestatusretry_after_seconds(用于决定何时重试)
5xx InternalServerErrorError / ApiErrorError codestatusdetails
其他 4xx UapiError codestatusdetails

其他 SDK

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

文档

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

uapi_sdk_python-0.1.1.tar.gz (32.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

uapi_sdk_python-0.1.1-py3-none-any.whl (31.2 kB view details)

Uploaded Python 3

File details

Details for the file uapi_sdk_python-0.1.1.tar.gz.

File metadata

  • Download URL: uapi_sdk_python-0.1.1.tar.gz
  • Upload date:
  • Size: 32.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for uapi_sdk_python-0.1.1.tar.gz
Algorithm Hash digest
SHA256 d0d68d00a928c6001ec6f5cebacd4c82713055ae2dd80533c154b6560aab54fa
MD5 723a67054c95cd7e4143533c556610a9
BLAKE2b-256 617e885bd11afc99b548facd2ededfedbb72ba6eb75425b9d2aa0f6c3c2f51bb

See more details on using hashes here.

File details

Details for the file uapi_sdk_python-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for uapi_sdk_python-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6162ccc94064d2e0940ac260149c88160eed6dddeab67fda3e86767da4a1c0b2
MD5 bec1b40e81798ca16ba2c5d35b642f75
BLAKE2b-256 f17633cc23372d25471f5330e1f5f1d1a889afe8191ed704c3d83d50179ae6db

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page