你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

适用于 JavaScript 的 Azure Core 服务客户端库 - 版本 1.9.3

此库主要用于由 AutoRestautorest.typescript生成的代码。

开始

当前支持的环境

有关详细信息,请参阅我们的 支持策略

安装

此包主要用于生成的代码中,不应由最终用户直接使用。

关键概念

ServiceClient

这是生成的客户端的常见基类。 它提供方法 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 响应对象转换为用户友好的表单。

后续步骤

可以通过执行 rushx test在本地生成和运行测试。 浏览 测试 文件夹以查看公共类的高级用法和行为。

详细了解 AutoRestautorest.typescript 扩展,以便在此包的基础上生成兼容的客户端。

故障 排除

如果在使用此库时遇到问题,请随时 提交问题。

贡献

若要参与此库,请阅读 贡献指南 了解有关如何生成和测试代码的详细信息。