Клиентская библиотека Azure Core Service для JavaScript версии 1.9.2
Эта библиотека в первую очередь предназначена для использования в коде, созданном AutoRest и autorest.typescript
.
Начало работы
Поддерживаемые в настоящее время среды
- LTS версии Node.js
- Последние версии Safari, Chrome, Edge и Firefox.
Чтобы получить дополнительные сведения, ознакомьтесь с нашей политикой поддержки.
Установка
Этот пакет в основном используется в созданном коде и не предназначен для непосредственного использования конечными пользователями.
Основные понятия
ServiceClient
Это общий базовый класс для созданных клиентов. Он предоставляет методы sendOperationRequest
и sendRequest
.
sendRequest
просто выполняет HTTP-запрос с помощью Pipeline
(см. @azure/core-rest-pipeline
для получения дополнительных сведений).
sendOperationRequest
используется созданным кодом для выполнения запроса с помощью OperationSpec
и OperationArguments
. OperationSpec
— это преобразование требований запроса из файла OpenAPI/Swagger, описывающего службу.
createClientPipeline
Этот метод используется для создания экземпляра Pipeline
, настраиваемого с помощью дополнительных политик, которые выполняют сериализацию и десериализацию. Основная часть работы заключается в преобразовании запросов в правильное HTTP-сообщение, которого ждет служба, и в последующем преобразовании полезных данных HTTP-ответа в форму ответа, описанную в файле спецификации OpenAPI службы.
Модули сопоставления / createSerializer
Mapper
используются для кодирования и декодирования данных в заголовки и тела HTTP. Они описывают все поля запроса и ответа. На них ссылаются OperationSpec
.
Метод createSerializer
создает объект Serializer
, который используется для выполнения основной части работы, преобразующей данные при выполнении запроса или обработке ответа. С учетом объема Mapper
и соответствующего объекта OperationSpec
он может производить объект HTTP-запроса от пользователя, предоставившего входные данные, или преобразовывать объект ответа HTTP в удобную для пользователя форму.
Дальнейшие действия
Вы можете создавать и запускать тесты локально с помощью команды rushx test
. Изучите папку test , чтобы узнать о расширенном использовании и поведении открытых классов.
Узнайте больше о AutoRest и расширении autorest.typescript для создания совместимого клиента на основе этого пакета.
Устранение неполадок
Если при использовании этой библиотеки возникают проблемы, вы можете сообщить о проблеме.
Участие
Если вы хотите вносить изменения в эту библиотеку, ознакомьтесь с руководством по внесению изменений, в котором содержатся сведения о создании и тестировании кода.
Azure SDK for JavaScript