OpenAI
页面内容为机器翻译。查看英文原文

如何将我的 API 客户端添加到“社区库”页面?

确保你的库已准备好添加到我们的“社区库”页面的标准与步骤

更新于:15 days ago

OpenAI 维护了一个 Community Libraries 页面,我们会在其中列出开发者可用来访问 OpenAI API 的 API 客户端。

如果你构建了一个希望添加到该页面的开源库——谢谢!我们很乐意看到开发者为其他开发者打造更多 API 工具。我们也希望确保引导开发者使用优质方案,以便长期取得成功,因此在将库列入我们的网站之前,我们要求满足一些标准。

请确认你符合下方列出的标准,然后填写我们的 Community Libraries request form

  1. 标准的开源许可证
    为便于列出,我们要求社区库使用 宽松的开源许可证(例如 MIT)。这样一来,如果库的所有者停止维护或不再添加功能,我们的客户在必要时就能更轻松地 fork 该库。

  2. 通过环境变量加载 API 密钥
    README 中的代码示例必须鼓励使用环境变量来加载 OpenAI API 密钥,而不是将其硬编码到源代码中。

  3. 正确、高质量且能准确反映 API 的代码
    代码应当易读、易跟随,并应总体遵循我们的 OpenAPI spec——新库不得包含该规范中标记为 deprecated: true 的端点。

  4. 说明这是非官方库
    请在 README 顶部附近的某处注明这是“非官方”或“由社区维护”的库。

  5. 承诺维护该库
    这主要意味着处理 issue,并审核与合并 pull request。你也可以参考我们在 Github Issue & PR templates 中的做法,例如我们的 官方 node 库

这篇文章对你有帮助吗?