APIクライアントSDKのベストプラクティスプロンプト

OpenAPI仕様から低レベルクライアントを生成し、その上に薄く慣用的なレイヤーだけを手書きする。信頼度: 0.85 API仕様を真実の源として扱い、生成コードが古くなった場合はCIを失敗させる。信頼度: 0.85 最初の呼び出しを3行で可能にする: インストール、APIキーでクライアント作成、1つのメソッド呼び出し。信頼度: 0.90 デフォルトでよく知られた環境変数からAPIキーを読み取り、ログやエラーメッセージに含めない。信頼度: 0.95 完全に型付けされたリクエストとレスポンスのモデルを公開し、TypeScript型またはPython型ヒントをパッケージに同梱する。信頼度: 0.90 HTTPステータス、エラーコード、メッセージ、リクエストIDを含む型付きエラーを、汎用例外の代わりに返す。信頼度: 0.90 タイムアウト、429、5xxレスポンスでべき乗バックオフとジッターを使用して冪等リクエストを再試行し、Retry-Afterヘッダーを尊重する。信頼度: 0.90 APIがサポートする場合、再試行されたPOSTリクエストに冪等性キーを自動的に送信する。信頼度: 0.80 適切なデフォルトタイムアウトを設定し、呼び出し元がクライアントごとおよびリクエストごとにタイムアウトと再試行設定を上書きできるようにする。信頼度: 0.85 自動ページネーションイテレーターを提供し、ユーザーがカーソルを自分で処理せずに全結果をループできるようにする。信頼度: 0.85 コールバックではなく、ネイティブの非同期イテレーターまたはジェネレーターでストリーミングレスポンスをサポートする。信頼度: 0.80 両方が一般的な言語で同期および非同期クライアントを提供し、同じモデルを共有する。信頼度: 0.75 ランタイム依存関係を最小限に保ち、特定のHTTPライブラリバージョンにユーザーを固定しない。信頼度: 0.85 SDK名、バージョン、ランタイムを含むUser-Agentヘッダーを送信し、API所有者が採用状況を確認して問題をデバッグできるようにする。信頼度: 0.80 セマンティックバージョニングを厳密に守り、破壊的変更を移行例とともにチェンジログに文書化する。信頼度: 0.90 マイナーリリースでメソッドを削除せず、まず警告付きで非推奨にする。信頼度: 0.85 速度のために記録されたHTTPフィクスチャに対してテストし、夜間に実サンドボックス環境に対して小規模なスイートを実行する。信頼度: 0.80 CIでサポートされているすべてのランタイムバージョンでテストスイートを実行する。例えば、各アクティブなNode.js LTSまたはPythonリリースなど。信頼度: 0.85 READMEとドキュメントに実行可能なコード例を置き、CIでそれらの例をテストして古くならないようにする。信頼度: 0.80 ロギング、トレーシング、カスタムヘッダー用のフックまたはミドルウェアを公開し、各ニーズに一回限りのオプションを追加しない。信頼度: 0.75 カスタムベースURLとHTTPクライアントを許可し、ユーザーがSDKをプロキシ、モック、またはリージョナルエンドポイントに向けられるようにする。信頼度: 0.80 CIからパッケージを出所情報付きで公開し、署名付きリリースを行い、メンテナーのラップトップからは決して公開しない。信頼度: 0.75