你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
适用于 JavaScript 的 Azure 核心服务客户端库 - 版本 1.9.2
此库主要用于 AutoRest 和 autorest.typescript
生成的代码。
入门
目前支持的环境
- LTS 版本的 Node.js
- 最新版本的 Safari、Chrome、Edge 和 Firefox。
有关更多详细信息,请参阅我们的支持政策。
安装
此包主要用于生成的代码,不应由最终用户直接使用。
关键概念
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 扩展,以便在此包之上生成兼容的客户端。
疑难解答
如果在使用此库时遇到问题,请随时提出问题。
贡献
若要为此库做出贡献,请阅读贡献指南,详细了解如何生成和测试代码。