TypeScript SDK 概览
如果你的项目是 TypeScript,通常应优先使用 @yuzuca/sdk,而不是直接拼 HTTP 请求。
SDK 已经把两类接入面拆成两个客户端:
| 客户端 | 对应接口面 | 适用场景 |
|---|---|---|
YuzucaPrivateClient | 服务端 API(/api/private/v1) | 代码运行在你自己的服务端,需要管理任意客户 |
YuzucaPublicClient | 客户端 API(/api/public/v1) | 代码运行在浏览器、移动端、桌面端,只操作当前登录客户自己的数据 |
什么时候优先 SDK
- 你希望直接获得请求和响应类型
- 你不想自己处理常见的 Header、签名和调用封装
- 你需要在 TypeScript 项目里快速完成接入
接下来该看哪一页
- 如果调用发生在你自己的服务端:继续看 YuzucaPrivateClient
- 如果调用发生在浏览器、移动端或桌面客户端:继续看 YuzucaPublicClient
- 如果你还没决定接入面:先回到 系统边界与接入方式
如果你需要直接核对 HTTP 契约或在非 TypeScript 环境接入,优先查看 HTTP API 文档 以及对应的 Scalar API 参考。