Azure Core Service client library for JavaScript - version 1.11.0

此連結庫主要用於由 AutoRestautorest.typescript所產生的程式代碼中。

開始

目前支持的環境

如需詳細資訊,請參閱我們的 支持原則

安裝

此套件主要用於產生的程式代碼中,而不是由終端使用者直接取用。

重要概念

服務用戶端

這是所產生用戶端的通用基類。 它會提供 方法 sendOperationRequestsendRequest

sendRequest 只是使用 Pipeline 提出 HTTP 要求(如需詳細資訊,請參閱 @azure/core-rest-pipeline

產生的程式代碼會使用 sendOperationRequest,以使用 OperationSpecOperationArguments提出要求。 OperationSpec 是 OpenAPI/Swagger 檔案中描述服務的要求需求的轉譯。

createClientPipeline

這個方法可用來建立 Pipeline 實例,這個實例會使用執行串行化和還原串行化的額外原則來自定義。 大部分的工作是將要求轉換成服務預期的正確 HTTP 訊息,然後將 HTTP 回應承載轉換成服務 OpenAPI 規格檔案所描述的響應圖形。

對應程式/ createSerializer

Mapper可用來將數據編碼和譯碼為 HTTP 標頭和主體。 它們會描述所有要求和回應欄位。 OperationSpec會參考它們。

方法 createSerializer 會建立一個 Serializer,用來在提出要求或處理回應時執行大量轉換數據的工作。 假設有 Mapper的主體和適當的 OperationSpec,它可以從使用者提供的輸入製造 HTTP 要求物件,或將 HTTP 回應物件轉換成方便使用的表單。

後續步驟

您可以在本機建置及執行測試,方法是執行 npm run test。 探索 測試 資料夾,以查看公用類別的進階使用方式和行為。

了解更多關於 TypeSpec@azure-tools/typespec-ts 發射器,用於在此套件之上產生相容用戶端。

故障排除

如果您在使用此連結庫時遇到問題,請隨意 提出問題。

貢獻

如果您想要參與此連結庫,請閱讀 參與指南,以深入瞭解如何建置和測試程序代碼。