Клиентская библиотека службы Azure Core для JavaScript версии 1.9.3

Эта библиотека в основном предназначена для использования в коде, созданном 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 службы.

Mappers / createSerializer

Mapperиспользуются для кодирования и декодирования данных в заголовки и тела HTTP. Они описывают все поля запроса и ответа. Они ссылаются на OperationSpecs.

Метод createSerializer создает Serializer, который используется для выполнения основной части рабочих преобразований данных при выполнении запроса или обработки ответа. Учитывая корпус Mapperи соответствующий OperationSpec он может производить объект HTTP-запроса от пользователя, предоставленный пользователем, или преобразовать объект ОТВЕТА HTTP в пользовательскую форму.

Дальнейшие действия

Вы можете создать и запустить тесты локально, выполнив rushx test. Изучите папку теста, чтобы просмотреть расширенное использование и поведение общедоступных классов.

Дополнительные сведения о autoRest и расширении autorest.typescript для создания совместимого клиента поверх этого пакета.

Устранение неполадок

Если при использовании этой библиотеки возникают проблемы, вы можете файл проблемы.

Способствует

Если вы хотите внести свой вклад в эту библиотеку, ознакомьтесь с руководством по вкладу, чтобы узнать больше о том, как создавать и тестировать код.