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

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

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

更新日: 7 days ago

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

このページへの追加を希望するオープンソースライブラリを構築された場合は、ありがとうございます!開発者が他の開発者のために追加の API ツールを構築してくださることを、私たちは嬉しく思います。また、開発者が長期的に成功できる優れたソリューションへ案内したいと考えているため、当社の Web サイトにライブラリを掲載する前に満たしていただくいくつかの基準を設けています。

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

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

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

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

README のコードサンプルでは、OpenAI API キーをソースコードにハードコーディングするのではなく、環境変数を使用して読み込むことを推奨する必要があります。

  1. API を忠実に反映する、正しく高品質なコード

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

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

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

  1. ライブラリの保守へのコミット

これは主に、Issue への対応と、プルリクエストのレビューおよびマージを意味します。当社の公式ノードライブラリにあるような GitHub Issue & PR テンプレートを設定するのも良い考えです。

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