Pontx Hub
pontx-hub を厳選されたAPIカタログへの信頼できるインターフェースとして使用します。現在のタスクに必要な製品、エンドポイント、スキーマのみを検索およびロードすることで、APIメタデータを長期コンテキストに保持することを避けます。
ワークフロー
-
APIを選択する前に検索します。自然言語による機能、リクエスト、レスポンスの質問に対応しています:
pontx-hub search "<capability>" --json pontx-hub search "创建任务的入参" --locale zh --json pontx-hub search "返回 dueDate 的接口" --locale zh --json必要に応じて結果タイプを絞り込みます:
pontx-hub search "<field-or-model>" --type schema --json -
選択した安定したリソースIDを確認します:
pontx-hub show endpoint:<api>/<endpoint> pontx-hub show schema:<api>/<schema> -
エンドポイントの場合、実際に送信せずに正確なリクエストを作成して確認します:
pontx-hub <api-collection> preview <api-name> --parameter value --body '<json>' pontx-hub <api-collection> preview <controller> <api-name> --parameter value --body '<json>' -
GETまたはHEADの場合、ユーザーが実行を要求した場合のみ呼び出します:
pontx-hub <api-collection> call <api-name> --parameter value pontx-hub <api-collection> call <controller> <api-name> --parameter value -
POST、PUT、PATCH、DELETEの場合、ドライランの結果を表示し、明示的なユーザー確認を得ます。その後、パラメーターを変更せずに
--yesを渡します:pontx-hub <api-collection> call <controller> <api-name> --parameter value --body '<json>' --yes -
リクエストの形状が確認されたら、統合コードを生成します:
pontx-hub sdk <api>
安全性
- 書き込み操作の承認を、APIの確認、説明、またはプレビューの要求から推測しないでください。
- 資格情報をコマンド引数に直接出力、表示、ログ記録、または配置しないでください。
- 資格情報は
showで指定された環境変数から読み取ります。 - Hubカタログ外の任意のURLや操作を呼び出さないでください。
- 変更操作に対して個別の
previewステップをバイパスしないでください。 - 変更されたパラメーター、本文、サーバー、または操作は、新たなドライランと確認が必要な新しいリクエストとして扱います。
- 資格情報の設定、認証の診断、または変更操作の実行時には references/auth-and-safety.md を参照してください。
出力
CLI出力をプログラムで利用する場合は --json を優先します。エラー報告時にはCLI終了コードと機械可読なエラーコードを保持します。結果の match.mode と match.fields を使用して、製品、パラメーター、リクエスト、レスポンス、スキーマ、またはプロパティメタデータのいずれがマッチを生成したかを説明します。アプリケーションコードを生成する際には、公開されている @pontx/<api-slug> パッケージを使用します。