用途:该技能用于搭建生成式 UI 应用,前端为 React,后端为 C#,由后端经 HttpClient 直接调用 OpenAI API 并把 SSE 流原样转发给前端,实现逐字流式输出。触发词包括 openui csharp、openui dotnet、aspnet core openui 等。
前置条件:Node.js >= 22(建议 24 LTS)、React >= 18.3.1(建议 19+)、.NET SDK 10.0、已设置 OPENAI_API_KEY 环境变量。
用法:先安装前端依赖 npm install @openuidev/react-ui @openuidev/react-headless @openuidev/react-lang lucide-react zod;再用 npx @openuidev/cli generate ./src/lib/library.ts --out backend/system-prompt.txt 生成系统提示词;创建 .NET 10 的 Web 后端(无需 NuGet 包),backend/openui-backend.csproj 指向 net10.0,Program.cs 注册名为 openai 的 HttpClient(无限超时)、按 FRONTEND_ORIGIN 配置 CORS、启动时读取 system-prompt.txt、提供 POST /api/chat 端点;最后后端 dotnet run 跑在 5000 端口,前端跑在 3000 端口。前端页面使用 FullScreen 组件,传入 openuiChatLibrary、streamProtocol={openAIAdapter()}、openAIMessageFormat 和 apiUrl="http://localhost:5000/api/chat",并在根布局导入相应 CSS。
主要能力与要点:后端用 HttpCompletionOption.ResponseHeadersRead 避免缓冲响应体,逐行读取 OpenAI 的 data: 分片并在每行后 FlushAsync,设置 Content-Type: text/event-stream 和 X-Accel-Buffering: no;CORS 用 WithOrigins 锁定来源而非 AllowAnyOrigin;DTO 用 JsonPropertyName 固定小写字段名。.NET 10 另有 TypedResults.ServerSentEvents 可作为解析分片时的替代;也存在官方 OpenAI .NET SDK 替代手写 HTTP 调用。
限制与排错:system-prompt.txt 缺失会抛 FileNotFoundException;未设 OPENAI_API_KEY 返回 500;上游 401/429 会原样转发;前端须用 openAIAdapter() 而非针对 NDJSON 的 openAIReadableStreamAdapter(),否则无输出;流一次性到达说明存在缓冲,需确认 ResponseHeadersRead 与逐行 FlushAsync。.env 不会自动加载,需 export 或使用 dotnet user-secrets。