JavaScript 用 Azure Core Service クライアント ライブラリ - バージョン 1.9.2

このライブラリは主に AutoRest および autorest.typescript によって生成されたコードで使用することを目的としています。

はじめに

現在サポートされている環境

• Node.js の LTS バージョン
• Safari、Chrome、Edge、Firefox の最新バージョン。

詳細については、Microsoft のサポート ポリシーを参照してください。

インストール

このパッケージは主に生成されたコードで使用され、エンド ユーザーが直接使用することを意図したものではありません。

主要な概念

ServiceClient

これは、生成されたクライアントの共通基本クラスです。 メソッド sendOperationRequest と sendRequest が提供されます。

sendRequest では、Pipeline を使用して HTTP 要求を行うだけです (詳細については、@azure/core-rest-pipeline を参照)。

sendOperationRequest は生成されたコードで使用され、OperationSpec と OperationArguments を使用して要求を行います。 OperationSpec は、サービスを記述する OpenAPI/Swagger ファイルからの要求要件を翻訳したものです。

createClientPipeline

このメソッドは、シリアル化と逆シリアル化を実行する追加のポリシーでカスタマイズされた Pipeline インスタンスを作成するために使用されます。 作業の大部分は、要求をサービスで予期される適切な HTTP メッセージに変換してから、HTTP 応答ペイロードをそのサービスの OpenAPI 仕様ファイルで記述された応答形式に変換することです。

Mapper / createSerializer

Mapper は、データをエンコードして HTTP ヘッダーと本文にデコードするために使用されます。 すべての要求および応答フィールドについて記述します。 これらは OperationSpec によって参照されます。

メソッド createSerializer では、要求時または応答の処理時にデータを変換する作業の大部分を実行するために使用される Serializer を作成します。 Mapper のコーパスと適切な OperationSpec がある場合、ユーザーが指定した入力から HTTP 要求オブジェクトを作成したり、HTTP 応答オブジェクトをユーザーフレンドリな形式に変換したりできます。

次のステップ

rushx test を実行することで、テストをローカルでビルドして実行できます。 テスト フォルダーを調べて、パブリック クラスの高度な使用状況と動作を確認します。

このパッケージを基に互換性のあるクライアントを生成するための AutoRest と autorest.typescript 拡張機能の詳細を確認します。

トラブルシューティング

このライブラリの使用中に問題が発生した場合は、お気軽に問題を提出してください。

共同作成

このライブラリに投稿する場合、コードをビルドしてテストする方法の詳細については、投稿ガイドを参照してください。