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

我如何將我的 API 用戶端加入 Community Libraries 頁面?

確保你的函式庫已準備好加入我們 Community Libraries 頁面的條件與步驟

更新日期:16 days ago

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

如果你建立了開源程式庫,並希望加入此頁面——謝謝你!我們樂見開發者為其他開發者建立額外的 API 工具。我們亦希望確保引導開發者使用優質方案,協助他們長遠成功,因此在網站列出程式庫之前,我們有幾項必要準則。

請確保你符合以下列出的準則,然後填寫我們的社群程式庫申請表

  1. 標準開源授權

如要列出,我們要求社群程式庫使用 MIT 等寬鬆式開源授權。這樣一來,若擁有者停止維護或新增功能,我們的客戶在有需要時可更輕鬆地分支複製程式庫。

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

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

  1. 準確反映 API 的正確高質素程式碼

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

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

請在 README 靠近頂部的位置聲明這是「非官方」或「由社群維護」的程式庫。

  1. 承諾維護程式庫

這主要指處理 issue,以及審閱並合併拉取請求。你亦可考慮設定 GitHub Issue 及 PR 範本,就像我們在官方節點程式庫中所做的一樣。

這篇文章對你有幫助嗎?