OpenAI
此頁面由機器翻譯。查看原始英文文章

如何將我的 API 用戶端加入社群程式庫頁面?

確保你的程式庫已準備好加入我們社群程式庫頁面的條件與步驟

更新日期:8 days ago

OpenAI 維護一個社群程式庫頁面,列出開發者可用來存取 OpenAI API 的 API 用戶端。

如果你建立了開放原始碼程式庫,並希望加入此頁面——謝謝你!我們很高興看到開發者為其他開發者打造更多 API 工具。我們也希望確保引導開發者使用優良的解決方案,協助他們長期取得成功,因此在我們的網站列出程式庫之前,我們有幾項必要條件。

請確認你符合下列條件,然後填寫我們的社群程式庫申請表

  1. 標準開放原始碼授權

若要列入清單,我們要求社群程式庫使用 MIT 等寬鬆式開放原始碼授權。如此一來,如果維護者停止維護或新增功能,我們的客戶在必要時就能更輕鬆地對程式庫進行分支。

  1. 透過環境變數載入 API 金鑰

README 中的程式碼範例必須鼓勵使用環境變數載入 OpenAI API 金鑰,而不是將其硬編碼在原始碼中。

  1. 正確、高品質且準確反映 API 的程式碼

程式碼應易於閱讀/理解,且一般應遵循我們的 OpenAPI 規格;新的程式庫不應包含此規格中標示為 deprecated: true 的端點。

  1. 聲明這是非官方程式庫

請在 README 靠近開頭處聲明,這是一個「非官方」或「由社群維護」的程式庫。

  1. 承諾維護該程式庫

這主要表示處理問題,以及審查並合併拉取要求。設定 Github Issue 和 PR 範本也會是不錯的做法,就像我們在官方 Node 程式庫中所做的一樣。

這篇文章有幫助嗎?