openai-openapi

官方 API 契约，一键生成客户端与文档

开源 🏷️定价信息待确认 ⏳ 访问状态待核验 基础设施 🍴 复刻 530 🐛 待处理 53 👀 关注 123
访问官网 ↗ GitHub ↗
GitHub 星标 ★ 2558
维护状态 活跃
是否开源 开源
定价模式 🏷️定价信息待确认

项目预览

openai-openapi 项目界面预览图
图片来源：GitHub 官方仓库名片

项目数据

分类基础设施
开发团队openai
官网地址https://platform.openai.com/docs/api-reference/introduction
GitHubhttps://github.com/openai/openai-openapi
定价模式🏷️定价信息待确认
价格说明规范文档免费查阅，API 调用按量计费
访问状态⏳ 访问状态待核验
是否开源是
开源协议MIT
技术栈/模型openai,openai-api
GitHub 星标★ 2558
上线时间2021-12-14 00:00:00
代码更新2026-10-24
仓库体积39.5 MB
本站数据更新2026-10-26
维护状态活跃
收录时间2026-10-26
浏览次数0

项目介绍

openai-openapi 是 OpenAI 官方 API 的 OpenAPI 规范描述文件仓库，用机器可读的 OpenAPI 文档定义聊天补全、嵌入、图像、音频、文件、微调、批处理等接口的路径、请求体、响应结构与鉴权方式。它解决的是接口契约分散、文档与实现不一致的问题：开发者无需手工猜测字段，可直接用规范生成客户端 SDK、服务端桩代码、Mock 服务与接口测试用例，也可导入 Postman、Swagger UI、Apifox 等工具做可视化调试与文档展示。核心能力包括完整的 schema 定义、枚举与错误响应描述、多语言代码生成兼容、以及随官方 API 迭代同步更新。项目本身不提供运行时服务，而是作为 API 集成的单一事实来源，适合需要稳定对接、自动化测试或构建网关代理层的工程团队使用。

Star 增长趋势

本站每日记录该项目 GitHub 星标变化，观测越久曲线越完整

数据来源：GitHub API 逐日快照 · 收录于 2026-10-26 · 当前星标 ★ 2558

技术标签

使用教程

ℹ 本教程由 AI 依据该项目 README 整理，个别步骤可能需要按你的环境微调。

难度：入门 约 5 分钟 部署方式：库/依赖 4 步

环境要求

  • 可访问 GitHub 原始文件地址的网络环境
  • 支持 OpenAPI 3.1 的解析或导入工具（如 Swagger UI、Postman、Apifox）
  • 无需安装运行时，仓库只提供规范文件

安装与启动步骤

  1. 1下载 YAML 规范

    用 README 给出的 curl 命令把最新版 openapi.yaml 下载到本地，文件名为 openapi-openapi.yaml。

    curl -L https://raw.githubusercontent.com/openai/openai-openapi/main/openapi.yaml -o openai-openapi.yaml

  2. 2下载 JSON 规范

    若工具更偏好 JSON，可直接从仓库根目录获取 openapi.json，内容与 YAML 等价。

  3. 3确认规范版本

    打开文件确认开头为 OpenAPI 3.1，并含 paths、components 等字段，说明文件完整。

    head -n 5 openapi-openapi.yaml

  4. 4导入工具使用

    把规范文件导入任意兼容 OpenAPI 的工具，用于浏览接口、生成客户端或做接口测试。

如何确认成功

文件开头显示 OpenAPI 3.1 版本号，且 paths 中能看到各接口路径定义即表示获取成功。

常见问题

Q：仓库需要安装或启动服务吗？

A：不需要。仓库只发布 OpenAPI 描述文件，不提供运行时，直接下载 openapi.yaml 或 openapi.json 使用即可。

Q：openapi.yaml 和 openapi.json 有区别吗？

A：两者内容等价，仅格式不同，都是随上游自动同步生成的产物，按你使用的工具支持的格式选择。

Q：导入时提示版本不支持怎么办？

A：文档使用 OpenAPI 3.1，需使用支持 3.1 的工具版本；较旧工具可能只支持 3.0，需升级工具。

Q：可以修改文件内容吗？

A：文件由上游自动同步生成，本地修改不会保留，属于只读产物，建议按 README 的贡献与反馈流程提意见。

注意事项

  • 本仓库仅提供接口规范，不含任何可执行代码或服务端实现。
  • 规范随官方 API 迭代自动更新，需要最新接口时重新下载文件即可。
  • 使用前确认所选工具支持 OpenAPI 3.1，避免解析报错。

核心亮点

  • 官方维护，schema 与线上 API 行为保持同步，减少字段猜测成本
  • 覆盖聊天、嵌入、图像、音频、文件、微调等主要接口，契约完整
  • 标准 OpenAPI 格式，可直接接入代码生成器、Mock 工具与接口测试流水线

不足之处

  • 仅提供规范文件，不含示例代码、SDK 或运行时实现，上手需自备工具链
  • 语言标记为未知，仓库以 YAML/JSON 为主，缺少配套校验与版本迁移说明

适用场景

  • 用 openapi-generator 批量生成多语言客户端 SDK
  • 导入 Swagger UI 或 Apifox 做接口文档展示与在线调试
  • 在 CI 中基于规范做契约测试与 Mock 服务，隔离真实 API 调用

替代项目

openai-python、openai-node、langchain

上一篇：openai-node

下一篇：tart

同类项目推荐

KVzip 开源

长文本推理显存直降4倍，延迟减半，即插即用

[NeurIPS'25 Oral] Query-agnostic KV cache eviction: 3–4× reduction in memory and 2···

★ 227 2026-08-09
datastoria 开源

AI 驱动 ClickHouse 诊断与查询优化，可视化一步到位

AI-native ClickHouse console for your cluster diagnostics and query generation, opti···

★ 327 2026-08-09
kiji-proxy 开源

给 OpenAI 请求加层隐私滤镜，敏感信息不外泄。

Privacy proxy for your OpenAI requests

★ 440 2026-08-09
TensorRT-LLM 开源

NVIDIA GPU 上跑大模型，编译优化后推理又快又省显存

TensorRT LLM provides users with an easy-to-use Python API to define Large Language ···

★ 14942 2026-09-15
frugon 开源

本地跑一跑，立刻看清 LLM 账单漏在哪

Free, local, open-source LLM cost analyzer - see where your LLM bill leaks, on your ···

★ 216 2026-08-09
gemini-web-to-api 开源

把 Gemini 网页版变成标准 API，一键接入现有 AI 应用

✨Reverse-engineered API for Gemini web app. It can be used as a genuine API key fro···

★ 614 2026-08-09
unstructured 开源

把 PDF/Word 等复杂文档，一键变成 LLM 能用的干净数据

Convert documents to structured data effortlessly. Unstructured is open-source ETL s···

★ 15622 2026-08-09
bc250 开源

用 PS5 同款 APU 主板，低成本跑本地大模型和文生图

AMD BC-250 (PS5 APU) setup guide — Ollama + Vulkan inference, poor man's AI assista···

★ 412 2026-09-16
vLLM-2080Ti-Definitive 开源

双2080Ti+NVLink跑Qwen 27B，单请求破100 tok/s

The definitive vLLM runtime for dual RTX 2080 Ti 22GB + NVLink, delivering Qwen 27B ···

★ 1181 2026-09-16