开源项目开发者工具类新手
openai/openai-cookbook：OpenAI API 使用示例与指南
openai/openai-cookbook 是 OpenAI 官方维护的示例代码与指南仓库，用于演示如何用 OpenAI API 完成常见任务。仓库以 Python 代码示例为主，运行前需要 OpenAI 账号和 API Key，并通过 OPENAI_API_KEY 环境变量或仓库根目录的 .env 文件完成配置，项目采用 MIT 许可证。
0 次阅读2026/09/11 发布
社区作者 · zZz
它解决什么问题
openai/openai-cookbook 是一个面向开发者的示例代码与指南集合，目标是帮助使用者用 OpenAI API 完成各类常见任务。仓库可直接在 cookbook.openai.com 站点导航浏览。
核心特点：
- 内容以可运行的示例代码和操作指南为主，而非框架或库本身；
- 绝大多数代码示例使用 Python 编写，但仓库明确说明其中的概念可以应用到任何编程语言；
- 运行示例的前提是拥有 OpenAI 账号并创建 API Key（来源提示可在此免费注册账号）；
- 认证方式为环境变量 OPENAI_API_KEY，或在多数 IDE（如 Visual Studio Code）中于仓库根目录创建 .env 文件写入 OPENAI_API_KEY=<your API key>，笔记本（notebook）会自动读取该配置；
- 仓库页面还提供了来自网络的其他实用工具、指南和课程等关联资源入口。
配图 1 为 OpenAI Cookbook 的 Logo（openai-cookbook.png）。
许可证：MIT License。
适用对象：希望学习并落地调用 OpenAI API 的开发者、数据科学家与技术团队，尤其是使用 Python 与 Jupyter Notebook 工作流的人群。
— 本文由 AI 根据公开来源辅助整理，命令、版本与许可证请在使用前到原始页面复核。
安装 / 开始使用
以下步骤依据仓库正文整理，按顺序执行即可跑通示例：
- 准备账号与密钥：注册 OpenAI 账号，并创建对应的 API Key（来源正文中提供了免费注册账号的链接入口）。
- 配置环境变量（方式一）：设置一个名为 OPENAI_API_KEY 的环境变量，取值为你的 API Key。
- 配置 .env 文件（方式二）：在多数 IDE（例如 Visual Studio Code）中，可以在你的仓库根目录创建一个 .env 文件，内容为：
OPENAI_API_KEY=<your API key>该文件会被 notebook 自动读取。
步骤 4 · 获取与运行示例：从仓库获取示例代码/notebook 后直接运行。绝大多数代码示例使用 Python 编写，需要具备可执行
Python 与 Jupyter Notebook 的本地环境。
- 其他语言：如果你的技术栈不是 Python，可参照示例中体现的调用概念，在任意语言中自行实现。
- 在线浏览：也可以通过 cookbook.openai.com 进行导航式阅读。
常见问题与注意事项：
- 未配置 OPENAI_API_KEY（环境变量或 .env）时，notebook 无法完成 API 调用，请先完成第 2 或第 3 步。
- 使用 .env 方式时，文件必须放在仓库根目录，否则 notebook 不会自动读取。
- 不要把真实 API Key 提交到版本库；仓库仅演示了本地环境变量与 .env 两种配置方式。
- 示例以 Python 为主，运行前请确认本地 Python/Notebook 环境可用；非 Python 语言需自行迁移示例逻辑。
来源教程配图
适用场景
学习并调用 OpenAI API 完成常见任务
参考 Python 示例代码快速搭建 API 调用原型
在 Jupyter Notebook / VS Code 环境中对照 notebook 实操
查阅 API Key 与 .env 的配置方式
跨语言迁移 API 调用思路（概念适用于任何语言）
作为团队内部 API 使用规范与示例的参考