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

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

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

更新于:10 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 模板也是个不错的做法,就像我们的官方节点库中那样。

这篇文章对你有帮助吗?