openai-openapi

OpenAI API 的 OpenAPI 規格

openai-openapi 是什麼?

OpenAI API 的 OpenAPI 規格是針對 OpenAI API 所提供的 OpenAPI 規範,類別為開發者工具,採用 MIT 授權。

openai-openapi 概覽

這是什麼

此儲存庫發布 OpenAI API 的 OpenAPI 規格。該規格以 OpenAPI 3.1 撰寫,提供 OpenAI REST API 的機器可讀描述。它描述了 API 的端點、驗證方式、參數以及請求和回應的結構。openapi.yaml 和 openapi.json 檔案是從上游來源自動同步產生的成品。

主要功能

  • 提供 OpenAI REST API 的完整 OpenAPI 3.1 規格。
  • 包含端點、驗證、參數和結構的定義。
  • 提供 YAML 和 JSON 兩種格式。
  • 可用於生成型別化客戶端、建立 API 探索工具以及設定測試工具。
  • 官方 SDK(Python、JavaScript/TypeScript、.NET、Go、Java、Ruby)皆由此規格生成。
  • 本專案採用 MIT 授權條款,為開放原始碼。

使用情境

開發者可在任何相容 OpenAPI 的工作流程中使用此規格來整合 OpenAI API。它適用於生成客戶端函式庫、建立 API 文件、設定自動化測試,以及建置自訂的 API 探索工具。此規格也可作為了解 OpenAI API 結構的參考。

快速開始

若要下載最新版本的 YAML 規格,請執行: sh curl -L https://raw.githubusercontent.com/openai/openai-openapi/main/openapi.yaml -o openai-openapi.yaml 然後即可將該文件匯入支援 OpenAPI 生態系的工具中。

授權與價格

本專案採用 MIT 授權條款。定價類型為開放原始碼。

內容整理自該專案公開的 README 與儲存庫資訊。

將此徽章加入你的 README

Featured on YunoDB 徽章樣式與說明

你是這個專案的維護者嗎?展示它已收錄於 YunoDB。

Markdown[![Featured on YunoDB](https://yunodb.com/badge/openaiopenai-openapi.svg)](https://yunodb.com/tools/openaiopenai-openapi?utm_source=github&utm_medium=badge)
HTML<a href="https://yunodb.com/tools/openaiopenai-openapi?utm_source=github&utm_medium=badge"><img src="https://yunodb.com/badge/openaiopenai-openapi.svg" alt="Featured on YunoDB" height="20"></a>