别再猜参数了OpenAI API OpenAPI 规范 5 分钟上手指南【免费下载链接】openai-openapiOpenAPI specification for the OpenAI API项目地址: https://gitcode.com/GitHub_Trending/op/openai-openapi还在对着文档一个个字段猜调用 OpenAI API 时你是不是也卡在这些问题上某个参数是必填还是可选object字段的枚举值到底有哪些400 错误的响应长什么样翻遍官方网页文档这些信息散落在几百个端点页面里。openai-openapi 仓库直接发布了 OpenAI API 的 OpenAPI 规范端点、参数、请求与响应 schema 全部以机器可读的单一文件交付官方六语言 SDK 也基于它生成。一图看懂 OpenAI API OpenAPI 规范OpenAI API 官方 OpenAPI 3.1 规范文件机器可读、可直接导入工具链。维度内容定位OpenAI REST API 官方机器可读规范协议OpenAPI 3.1.0文件openapi.yaml / openapi.json覆盖规模230 端点、17 个功能模块、约 2000 个 schema认证Bearer API Key协议条款MIT这两个文件是从上游源自动生成的产物。直接改仓库里的 YAML 不会同步回上游发现问题应走 issue 反馈流程。它能帮你做什么端点全量清单路径即目录paths部分按 HTTP 方法完整定义了全部接口。以你天天用的聊天补全为例/chat/completions: post: operationId: createChatCompletion tags: - Chat summary: Create chat completion requestBody: required: true content: application/json: schema: $ref: #/components/schemas/CreateChatCompletionRequest一个端点里请求结构、是否必填、返回什么类型一目了然不用开浏览器翻五个页面。约 2000 个 schema定义可无限复用components.schemas是整份规范的积木区每个数据结构都有类型、描述和示例schemas: AdminApiKey: type: object description: Represents an individual Admin API key in an org. properties: id: example: key_abc同一份CreateChatCompletionRequest定义文档、Mock、客户端生成共用天然不存在漂移。官方 SDK 都从这份 spec 生成OpenAI 官方客户端直接以该规范为输入语言 / 平台官方 SDK 仓库Pythonopenai-pythonJavaScript / TypeScriptopenai-node.NETopenai-dotnetGoopenai-goJavaopenai-javaRubyopenai-ruby规范是蓝图SDK 是产物——看懂规范你就看懂了所有官方客户端的来历。3 步跑通 OpenAPI 规范导入克隆仓库拿到openapi.yamlgit clone https://gitcode.com/GitHub_Trending/op/openai-openapi ls openai-openapi/openapi.yaml先用grep定位端点验证内容结构全文约 12 万行定位比翻阅快得多grep -n operationId: createChatCompletion openapi-openapi/openapi.yaml # 2278: /chat/completions:把openapi.yaml导入 Swagger UI 或 Redoc获得交互式浏览与在线调试页面看到createChatCompletion卡片和可折叠的请求体即导入成功。这一步之后你手上就有了一份可以喂给任何 OpenAPI 兼容工具链的API 地图。这些坑我帮你踩过了进阶用 openapi-generator 反向生成你自己的客户端规范不只给人看还能生成代码openapi-generator-cli generate \ -i openai.yaml \ -g python \ -o my-client指向 spec 里任意一个operationId都能生成对应方法签名比手写类型省下一天。三个高频踩坑点现象12 万行 YAML 从头读到尾一小时后仍在 Assistants 模块。原因文件按模块线性排列人眼检索效率极低。解法grep -n operationId: xxx先定位行号再按行号范围阅读。现象本地给openapi.yaml打了补丁下次同步后补丁消失。原因文件由上游自动生成的流水线刷新直接编辑不会回流。解法改动需求走 issue 反馈本地只把规范当只读输入。现象按官方 SDK 的新参数调用报错spec 里却查不到该字段。原因网页文档更新快spec 版本可能滞后枚举校验严格导致未知值被拒。解法开工前先看info.version核对版本再升级客户端代码。和社区维护的第三方规范有什么不同社区 spec 靠人工跟踪 API 变更容易漏字段这份规范是官方自动同步、且直接生成官方 SDK 的那一份。配套工具与延伸阅读README.md规范获取方式、官方 SDK 列表与反馈渠道CONTRIBUTING.md贡献政策明确 PR 权限与 issue 流程SECURITY.md疑似漏洞的私密上报入口Swagger UI / Redoc / openapi-generator把 spec 变成调试页与客户端的标准工具链一份规范文件替代你对 API 细节的所有猜测。Star 一下仓库用它跑通你的第一个 OpenAPI 工具链吧。【免费下载链接】openai-openapiOpenAPI specification for the OpenAI API项目地址: https://gitcode.com/GitHub_Trending/op/openai-openapi创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考