开发者
开发者
开发者中心讲清 AI API 接入路线、SDK 示例、Cookbook、错误排查、生产验证、Codex 协作和 OfApp.cn 统一入口边界。
开发者中心面向需要把 AI 接进产品、脚本、内部系统、自动化流程或本地项目的人。这里不把 API 写成参数清单，而是把“怎样从最小请求走到可维护集成”拆成路线：验证 Key 和 Base URL，选择 SDK 或 HTTP 示例，处理流式输出和错误重试，再把日志、密钥、监控、测试和人工复核补齐。
| 项目 | 说明 |
|---|---|
| 阅读时间 | 约 5 分钟 |
| 更新时间 | 2026-07-03 |
| 适合读者 | 后端工程师、前端工程师、全栈开发者、产品技术负责人、自动化脚本作者 |
| 你会获得 | 接入路线、示例选择、错误排查顺序、上线前清单和 OfApp.cn 使用边界 |
这页解决什么
Section titled “这页解决什么”AI API 接入最容易卡在两类问题：一类是“请求能不能跑通”，另一类是“跑通后能不能稳定上线”。开发者中心把这两类问题放在同一条路径里：先用最小请求确认身份、入口和模型，再扩展到 SDK、流式输出、图片、Embedding、RAG、Codex 工作流和生产错误处理。
| 问题 | 直接入口 | 读完后继续 |
|---|---|---|
| 还没有跑通过请求 | 快速开始 | OpenAI-compatible API 快速开始 |
| 想复制代码示例 | Cookbook | curl 示例 或 SDK 示例 |
| 需要改项目代码 | Codex 教程 | 用 Codex 写代码 |
| 遇到鉴权或路径错误 | API 错误排查中心 | 401 或 404 |
| 想做图片生成 | GPT Image | GPT Image 接入教程 |
| 需要 Claude 兼容格式 | Claude 兼容生态 | Messages 兼容接口说明 |
开发者接入路线图
Section titled “开发者接入路线图”| 家族 | 解决的问题 | 推荐入口 |
|---|---|---|
| 快速开始 | Key、Base URL、模型名和最小请求 | OfApp.cn 快速开始 |
| Cookbook | 可复制的 HTTP、SDK、流式、图片、Embedding 和重试示例 | Cookbook |
| SDK | JavaScript、Python 和服务端封装 | 如何用 OpenAI SDK 接入 |
| Responses / Chat | 新项目生成文本、旧项目迁移、结构化输出 | Responses API 示例 |
| Errors | 401、403、404、429、5xx、上下文、模型名、流式中断 | API 错误排查中心 |
| Codex | 让 AI 代理读项目、改代码、跑测试、写交付说明 | Codex 教程 |
| 工作流 | 写作、办公、数据分析、图片视频和自动化落地 | AI 工作流 |
接口形态怎么选
Section titled “接口形态怎么选”开发者常见的误区是把所有需求都塞进一个示例里。更稳的做法是先看任务形态，再选择最小可验证入口。
| 任务形态 | 更适合的入口 | 判断标准 |
|---|---|---|
| 新项目文本生成 | Responses API 示例 | 需要统一处理文本、工具、上下文或后续扩展 |
| 旧项目迁移 | Chat Completions 示例 | 现有代码已经围绕 messages 和聊天补全组织 |
| 前端实时展示 | OpenAI API 流式输出示例 | 用户需要边生成边看到结果，且前端能处理中断 |
| 图片生成 | 图像生成 Images API 示例 | 需要保存图片、记录 Prompt、复核发布风险 |
| 语义检索 | Embeddings 与 RAG 检索示例 | 服务商已开放对应端点，并且你能维护索引一致性 |
| Claude 兼容生态 | Claude Messages 兼容接口说明 | 客户端或 SDK 明确要求 Anthropic Messages 格式 |
这张表不是替代官方文档，而是帮你减少路径选择成本。真正进入项目代码前，仍要用当前控制台、服务商文档和最小请求复核可用性。
| 原则 | 做法 | 避免什么 |
|---|---|---|
| 最小验证先行 | 先跑一个最小请求，确认 Key、Base URL 和模型名 | 一上来就接复杂业务和多轮工具链 |
| 密钥不进前端 | Key 放在服务端、环境变量或部署 Secret | 写进浏览器代码、README、截图和日志 |
| 模型来自控制台 | 从 OfApp.cn 控制台或官方文档复制可用模型 | 凭旧教程、聊天记录或示例猜模型名 |
| 错误可复现 | 保存状态码、请求 ID、端点、脱敏请求体和时间 | 只说“不能用”，不给最小复现 |
| 输出可验证 | 对结构化结果、总结、代码和图片都设计人工复核 | 把模型输出直接写入生产数据 |
| 生产有退路 | 设置超时、重试、限流、降级、日志和回滚方式 | 无限重试、无监控、无熔断 |
什么时候使用 OfApp.cn
Section titled “什么时候使用 OfApp.cn”OfApp.cn 适合在你需要统一入口时出现：同一把 Key 用于网页体验、SDK 示例、Codex、客户端或内部工具；同一个 Base URL 让团队少维护一套分散配置。官方页面已经提供天才游乐场、API 文档和 Codex 接入说明，开发者接入前应以这些入口核对最新信息。
如果页面、代码或教程涉及模型、价格、套餐、额度、地区限制、端点开放情况和具体能力，本站统一写成“请以 OfApp.cn 控制台或官方文档为准”。这样做不是回避细节，而是避免把会变化的信息写成静态承诺。
从原型到上线
Section titled “从原型到上线”| 阶段 | 应该完成什么 | 对应页面 |
|---|---|---|
| 本地验证 | 用示例 Key 占位，确认 Base URL、端点路径和模型名来源 | 如何配置 Base URL |
| 代码接入 | 在服务端封装 SDK 调用，前端只调用自己的后端接口 | JavaScript SDK 示例 |
| 输出处理 | 处理流式输出、空结果、截断、格式错误和用户取消 | OpenAI API 流式输出示例 |
| 错误策略 | 区分鉴权、路径、限流、服务端错误和网络超时 | 错误重试示例 |
| 上线复核 | 确认脱敏日志、监控、重试边界、人工复核和回滚方式 | 常见错误排查 |
生产前检查清单
Section titled “生产前检查清单”- API Key 只存在于安全环境变量、部署 Secret 或控制台里。
- Base URL 没有漏写版本路径，也没有重复拼接版本路径。
- 模型名来自当前控制台或官方文档，页面不写无法确认的固定模型。
- SDK 示例在服务端运行，浏览器端不直连带密钥的 API。
- 日志已脱敏，不记录完整 Key、用户隐私、文件全文或内部数据。
- 429、5xx、网络超时和流式中断都有明确处理方式。
- 自动化流程保留人工复核点，不把不可验证输出直接写进生产。
- 文档、README 和排错说明都使用假 Key，例如
sk-xxxx。
| 来源 | 适合核对什么 |
|---|---|
| OfApp.cn 首页 | 网页入口、天才游乐场、Key、Codex 和客户端使用场景 |
| OfApp.cn API 文档 | Base URL、API 示例、Codex 接入和当前官方说明 |
| 天才游乐场 | 网页体验、聊天、写作、读文件和生图入口 |
| OpenAI API 文档 | OpenAI API 概念、请求形态、安全和错误处理原则 |
开发者应该先看快速开始还是 Cookbook？
Section titled “开发者应该先看快速开始还是 Cookbook？”还没有跑通过请求时先看快速开始；Key、Base URL 和模型名验证后，再去 Cookbook 复制具体示例。这样排错路径更短，也更容易判断问题在配置还是业务代码。
OpenAI-compatible 是否等于完全兼容？
Section titled “OpenAI-compatible 是否等于完全兼容？”不等于。它通常表示请求形态和常见 SDK 用法接近 OpenAI API，但模型、端点、参数、错误格式和开放范围仍可能不同。每个项目上线前都要用当前服务商文档和最小请求验证。
为什么不在开发者页写固定模型名？
Section titled “为什么不在开发者页写固定模型名？”模型可用性会随账号、控制台、官方文档和服务策略变化。开发者页是长期入口，不适合写会快速过期的固定模型；具体模型请从 OfApp.cn 控制台或官方文档复制。
前端项目能不能直接调用 API？
Section titled “前端项目能不能直接调用 API？”不建议。只要浏览器端携带 API Key，就有泄露风险。更稳的做法是让前端调用自己的后端路由，由后端读取环境变量并转发请求。
什么时候需要 Codex？
Section titled “什么时候需要 Codex？”当你不仅要“看示例”，还要把示例接进真实项目、补测试、改 README、处理 Dockerfile 或排查构建错误时，Codex 更合适。它可以读取仓库、修改文件、运行验证，再给出交付说明。
API 报错应该从哪里查？
Section titled “API 报错应该从哪里查？”先记录状态码、端点、请求时间、脱敏请求体和响应摘要，再按错误中心排查。401 多半从 Key 和请求头查起，404 从 Base URL 和路径查起，429 从并发、重试和额度策略查起。
- OpenAI-compatible API 快速开始：验证 Key、Base URL、模型名和最小请求。
- 如何用 OpenAI SDK 接入：用 SDK 配置服务端调用。
- Cookbook：查找可复制的 API、SDK、stream、Embedding、图片和重试示例。
- Responses API 示例：了解 Responses 风格调用和迁移边界。
- API 错误排查中心：按错误类型定位问题。
- Codex 教程：把开发任务交给代码代理执行和验证。
- AI 辅助开发：从需求拆解到交付复核建立工作流。
开发者内容的核心不是“示例越多越好”，而是每个示例都能验证、能排错、能上线、能解释边界。先跑通最小请求，再选择 SDK、Cookbook、Codex 或工作流入口；需要统一 API 入口时，用 OfApp.cn 官方文档和控制台确认当前配置。