Azure Core Service client library for JavaScript - version 1.11.0

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

はじめ

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

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

取り付け

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

主な概念

サービスクライアント

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

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

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

createClientPipeline

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

Mappers/ createSerializer

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

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

次の手順

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

このパッケージの上に互換性のあるクライアントを生成する TypeSpec@azure-tools/typespec-ts エミッターについて詳しく学びましょう。

トラブルシューティング

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

貢献

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

  • Last updated on