OpenAI
このページは機械翻訳されています。元の英語の記事を表示

API クライアントをコミュニティライブラリページに追加するには?

ライブラリをコミュニティライブラリページに追加する準備が整っていることを確認するための基準と手順

更新日: 7 days ago

OpenAI は、開発者が OpenAI API へのアクセスに利用できる API クライアントを掲載するコミュニティライブラリページを運営しています。

オープンソースライブラリを開発し、このページへの掲載を希望される皆さま、ありがとうございます!開発者が他の開発者のために新たな API ツールを構築してくださることを、私たちはうれしく思います。また、開発者が長期的な成功につながる優れたソリューションを選べるようにしたいと考えています。そのため、ライブラリを当社のウェブサイトに掲載する前に、いくつかの基準を満たしていただく必要があります。

以下の基準を満たしていることを確認してから、コミュニティライブラリ申請フォームにご記入ください。

  1. 標準的なオープンソースライセンス

掲載対象となるコミュニティライブラリには、MIT などの寛容なオープンソースライセンスを使用する必要があります。これにより、所有者が保守や機能追加を停止した場合でも、必要に応じてお客様がライブラリを容易にフォークできます。

  1. 環境変数による API キーの読み込み

README のコード例では、OpenAI API キーをソースコードにハードコードせず、環境変数から読み込む方法を推奨する必要があります。

  1. API を正確に反映した、高品質で正しいコード

コードは読みやすく理解しやすいものとし、原則として当社の OpenAPI 仕様に準拠する必要があります。新しいライブラリには、この仕様で deprecated: true と記されたエンドポイントを含めないでください

  1. 非公式ライブラリであることの明記

README の冒頭付近に、「非公式」または「コミュニティによって保守されている」ライブラリであることを明記してください。

  1. ライブラリの継続的な保守

これは主に、イシューへの対応とプルリクエストのレビューおよびマージを意味します。当社の公式 Node.js ライブラリのように、GitHub イシューと PR のテンプレートを用意するのもよいでしょう。

この記事は役に立ちましたか?