SuperAPI AI 工具集

x-request

编程与开发

查看项目

更新于 10-15 17:27

技能介绍

XRequest 是 @antdv-next/x-sdk(≥2.2.2)提供的请求工具,用于统一处理网络通信、认证管理、错误处理与流式响应,重点解决如何正确配置以适配各类流式接口需求。

主要能力:内置 fetch 封装、Token 管理、重试机制与 SSE 流式处理,支持 SSE 与 JSON 两种响应格式,并有合理默认配置,多数情况只需提供 API URL。

安装:tnpm install @antdv-next/x-sdk,或 npm add @antdv-next/x-sdk;用 npm ls @antdv-next/x-sdk 检查版本。

基本用法:import { XRequest } from "@antdv-next/x-sdk"; 之后调用 XRequest("https://api.example.com/chat")。在 Provider 场景用于手动控制时,可传 { manual: true }。

安全限制:浏览器前端禁止配置密钥和 Authorization,否则会直接暴露;密钥应仅在 Node.js 后端通过环境变量配置,或经同源代理转发,浏览器端改用 /api/proxy/... 形式。useXChat 仅用于前端环境,其 XRequest 配置不得含 Authorization。

调试可分别使用 Node.js 环境变量或前端代理路径发起测试请求,并有安全配置校验函数检查浏览器环境下是否误加 Authorization。使用前应确认 API URL、认证信息与 manual 配置,完成后运行 tsc --noEmit 检查类型并清理未使用变量。可与 x-chat-provider、use-x-chat 组合,用于测试接口、适配私有 API 或构建完整 AI 对话应用。其他未提供细节暂未说明。