Cookbook

Cookbook 面向已经准备动手的开发者：你可能要用 cURL 验证一个 Key，用 JavaScript 或 Python 接入服务端，用 stream 做前端实时展示，用 Images 生成图片，或者给生产接口补超时、重试和脱敏日志。这里的目标不是堆代码，而是帮你选对示例、跑通最小请求，再把它扩展成可维护的项目实现。

先跑通最小请求，再接入真实项目

本文示例围绕 OfApp.cn 的 OpenAI 兼容接口组织。你可以用同一套 Base URL、Key 和模型来源连接 cURL、SDK、Codex 和内部工具；具体模型、能力、额度和价格请以 OfApp.cn 控制台或官方文档为准。

查看 OfApp API 文档

项目	说明
阅读时间	约 5 分钟
更新时间	2026-07-03
适合读者	后端工程师、全栈开发者、脚本作者、产品技术负责人、需要排查 API 问题的人
你会获得	示例选择方法、最小配置、常见接口入口、生产前复核清单和相关教程

Cookbook 适合解决什么

Cookbook 适合在“已经知道要调用 API，但还没确定示例怎么选”的阶段使用。它回答的问题不是“AI 能做什么”，而是“我现在要复制哪一段示例、怎样确认它真的能跑、出错时先查哪里”。

你现在的状态	建议动作	对应页面
还没验证 Key 和 Base URL	跑最小请求，确认入口和模型来源	OpenAI 兼容 API 快速调用
只想确认 HTTP 请求形态	用 cURL 排除 SDK 和框架干扰	curl 示例
新项目要生成文本	优先看 Responses 风格示例，再确认服务商支持情况	Responses API 示例
旧项目已经用聊天补全	沿用 messages 结构，逐步迁移	Chat Completions 示例
前端要实时展示输出	处理 stream、SSE、中断、取消和部分内容保存	OpenAI API 流式输出示例
生产环境不稳定	增加超时、退避重试、幂等和脱敏日志	错误重试示例

示例选择路线图

使用前提

本站 API 示例统一用环境变量表达，不在代码里写真实 Key。真实模型名、可用端点和能力范围都应从 OfApp.cn 控制台或官方文档确认。

export OPENAI_BASE_URL="https://api.ofapp.cn/v1"
export OPENAI_API_KEY="sk-xxxx"
export OPENAI_MODEL="以控制台可用模型为准"

如果某个工具会自动拼接版本路径，Base URL 可能需要填写到域名层级；如果工具要求完整版本路径，则使用文档要求的形式。遇到 404 或路径重复时，先看 如何配置 Base URL。

示例入口

示例	适合解决什么	验收方式
OpenAI 兼容 API 快速调用	验证 Key、Base URL、模型名和最小请求	最小请求返回可读响应
curl 示例	排除 SDK、框架和构建工具干扰	终端请求能复现成功或失败
Responses API 示例	使用 Responses 风格生成文本或处理后续扩展	明确输入、输出和兼容边界
Chat Completions 示例	维护已有 messages 结构和旧项目	多轮 messages 能稳定返回
图像生成 Images API 示例	生成图片、保存文件、记录 Prompt 和参数	图片可保存，参数可追溯
Embeddings 与 RAG 检索示例	设计语义搜索、切块、索引和召回流程	向量端点可用，检索结果可复核
OpenAI API 流式输出示例	处理 stream、SSE、前端展示和中断恢复	前端能显示增量内容并处理取消
Python SDK 示例	写脚本、后端任务和数据处理	环境变量加载正确，错误可捕获
JavaScript SDK 示例	Node.js 服务端、API 路由和后台任务	Key 不进浏览器，日志已脱敏
错误重试示例	处理 429、5xx、网络超时和幂等性	重试次数、退避和失败记录明确

示例选择表

你想做什么	优先选择	不建议的做法
先确认配置是否正确	cURL 或 OpenAI 兼容 API 快速调用	直接接入完整业务流程
新项目文本生成	Responses API，前提是服务商支持	把旧 messages 逻辑和新输入结构混在一起
迁移旧代码	Chat Completions，再逐步评估迁移	一次性改动所有请求层
前端实时展示	Streaming 示例	只在本地成功，不处理用户取消和网络中断
生成图片	Images 示例	只保存图片，不记录 Prompt 和参数
做知识库检索	Embeddings 与 RAG 示例	不确认端点可用就设计索引
提升稳定性	错误重试示例	对所有错误无限重试

从示例到项目代码

示例能跑通只说明入口正确，还不代表可以上线。把 Cookbook 示例接入项目时，建议按下面顺序推进：

1. 用 cURL 复现最小请求。
2. 把同一组环境变量接入 SDK。
3. 在服务端封装请求，不让浏览器接触 API Key。
4. 为 401、403、404、429、5xx 和网络超时写清楚处理分支。
5. 对用户输入、模型输出、日志和文件内容做脱敏。
6. 为流式输出、图片保存、向量索引和重试逻辑准备人工复核点。

OfApp.cn 接入边界

OfApp.cn 官方页面提供网页入口、API 文档、天才游乐场和 Codex 接入说明。Cookbook 里可以把 https://api.ofapp.cn/v1 作为 OpenAI 兼容接口示例，但不能把模型、套餐、额度、价格或能力写成静态承诺。无法确认的信息统一回到控制台或官方文档复核。

如果你只是想体验聊天、写作、读文件或生图，可以先进入天才游乐场；如果你要把 API 接到产品、脚本、SDK 或 Codex，再从本页选择对应示例。

生产前复核清单

• API Key 是否只在服务端、环境变量或部署 Secret 中出现。
• Base URL 是否和当前工具要求一致，没有重复拼接版本路径。
• 模型名是否来自 OfApp.cn 控制台或官方文档。
• 请求示例是否能用 cURL 独立复现。
• SDK 调用是否设置超时、错误捕获和必要重试。
• 日志是否脱敏，是否避免记录完整 Key、隐私文本和文件全文。
• 流式输出是否处理断开、取消和部分内容保存。
• 图片、向量、批处理和自动化结果是否保留人工复核点。

官方参考

来源	适合核对什么
OfApp.cn 首页	网页入口、天才游乐场、Key、Codex 和客户端使用场景
OfApp.cn API 文档	Base URL、API 示例、Codex 接入和当前官方说明
天才游乐场	聊天、写作、读文件、生图等网页体验入口
OpenAI API 文档	Responses、Chat Completions、错误处理和安全边界

常见问题

Cookbook 示例是否保证所有兼容服务都支持？

不保证。OpenAI 兼容通常表示请求形态接近 OpenAI API，但模型、端点、参数、错误格式和开放范围仍要以当前服务商文档和实际测试为准。

为什么示例不用具体模型名？

为了避免把会变化的信息写死。请从 OfApp.cn 控制台或官方文档复制真实可用模型名，再放入 OPENAI_MODEL 或项目配置。

可以在浏览器里直接使用这些示例吗？

不建议。浏览器端会暴露 API Key。前端应用应调用自己的服务端接口，由后端读取环境变量并转发请求。

Responses 和 Chat Completions 应该选哪个？

新项目可以优先评估 Responses 风格；已有项目如果围绕 messages 和聊天补全组织，可以先保留 Chat Completions，再规划迁移。具体可用性仍要以当前服务商文档和测试结果为准。

Streaming 示例为什么要单独看？

流式输出不仅是把 stream 打开，还涉及 SSE 解析、用户取消、连接中断、部分内容保存和前端展示状态。生产场景要单独验证这些边界。

错误重试是不是越多越好？

不是。401、403、404 这类配置或权限问题不应反复重试；429、5xx 和网络超时可以按有限次数、指数退避和幂等规则处理，并记录失败证据。

相关文章

• OfApp.cn 快速开始：从 Key、Base URL 和最小验证开始。
• OpenAI-compatible API 快速开始：先跑通最小请求。
• 如何用 OpenAI SDK 接入：把示例接到 JavaScript 或 Python SDK。
• 开发者中心：从原型、示例、排错到生产复核建立路线。
• API 错误排查中心：排查鉴权、路径、模型、限流和网络错误。
• Codex 教程：让 Codex 帮你把示例接入真实项目。
• AI 辅助开发：把 API 接入变成可复核开发流程。

带走什么

Cookbook 的价值不是复制一段代码就结束，而是让你知道该选哪个示例、怎样验证、哪里会失败、上线前要补什么。先用最小请求确认入口，再进入 SDK、流式输出、图片、向量、重试和项目集成；涉及 OfApp.cn 的可变信息，始终以控制台或官方文档为准。