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

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

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

更新于:12 days ago

OpenAI 维护着一个社区库页面,其中列出了开发者可用于访问 OpenAI API 的 API 客户端。

如果您开发了一个开源库,并希望将其添加到此页面,我们深表感谢!我们很高兴看到开发者为其他开发者构建更多 API 工具。我们也希望确保向开发者推荐优质的解决方案,帮助他们取得长期成功。因此,库必须符合若干标准,才能在我们的网站上列出。

请确保您符合下列标准,然后填写我们的社区库申请表

  1. 标准开源许可证

要列入页面,社区库必须使用 MIT 等宽松的开源许可证。这样一来,如果所有者停止维护或添加功能,我们的客户便可在必要时更轻松地派生这些库。

  1. 通过环境变量加载 API 密钥

README 中的代码示例必须建议通过环境变量加载 OpenAI API 密钥,而不是将其硬编码到源代码中。

  1. 代码正确且质量高,能够准确反映 API

代码应易于阅读和理解,并且通常应遵循我们的 OpenAPI 规范。新库不得包含此规范中标记为 deprecated: true 的端点。

  1. 声明这是非官方库

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

  1. 承诺维护该库

这主要意味着处理议题,以及审核并合并拉取请求。还可以参照我们的官方 Node 库,设置 GitHub 议题和 PR 模板。

这篇文章对你有帮助吗?