用途:x-request 关注如何正确配置 XRequest,以适应各类流式接口需求,内容涵盖快速上手、技术栈、核心配置、安全指南、调试测试、使用场景与开发规则。
依赖与安装:核心 SDK 为 @ant-design/x-sdk,版本要求 ≥2.2.2。推荐 tnpm install @ant-design/x-sdk,或使用 npm add @ant-design/x-sdk;用 npm ls @ant-design/x-sdk 检查版本。
基本用法:从 '@ant-design/x-sdk' 导入 XRequest。最小配置只需提供 API URL,如 XRequest('https://api.example.com/chat');Provider 场景下可传 { manual: true }。多数情况只需提供 API URL。
主要能力:处理网络请求、认证管理、错误处理与流式处理,支持 SSE 与 JSON 响应格式,可配置全局配置、安全配置与流式配置。可独立发起请求,也可与 x-chat-provider、use-x-chat 配合,用于私有 API 适配或标准 AI 应用。
安全与限制:浏览器前端属高风险,禁止配置密钥;Node.js 后端与代理服务属安全方式,可用环境变量或同源代理转发。认证方式上 Bearer Token、API Key Header、代理转发安全,浏览器直接配置密钥危险。使用 useXChat 时仅为前端环境,XRequest 配置不得包含 Authorization。
调试与验证:Node.js 调试可用 process.env 读取密钥,前端调试走 /api/debug/chat 之类路径;可用 validateSecurity 校验前端是否误配 Authorization。完成后需运行 tsc --noEmit 检查类型,保持代码干净。若用户未明确需要测试用例,不加测试文件。
适用场景:测试接口可用性、私有 API 适配、标准 AI 应用、完整定制等。
其它说明:条目中提及 CORE.md、API.md、EXAMPLES_SERVICE_PROVIDER.md、useXChat/XRequest/Chat Provider 官方文档及 custom-provider-width-ui.tsx 示例等参考资源。关于收费、价格与效果等事实,资料暂未提供。