Biblioteca cliente de Azure Core Service para JavaScript: versión 1.9.2
Esta biblioteca está pensada principalmente para usarse en el código generado por AutoRest y autorest.typescript
.
Introducción
Entornos admitidos actualmente
- Versiones de LTS de Node.js
- Versiones más recientes de Safari, Chrome, Edge y Firefox.
Para más información, consulte la directiva de compatibilidad.
Instalación
Este paquete se usa principalmente en el código generado y no está pensado para que lo consuman directamente los usuarios finales.
Conceptos clave
ServiceClient
Clase base común para los clientes generados. Proporciona los métodos sendOperationRequest
y sendRequest
.
sendRequest
simplemente realiza una solicitud HTTP mediante Pipeline
(consulte @azure/core-rest-pipeline
para obtener más información).
El código generado usa sendOperationRequest
para realizar una solicitud mediante OperationSpec
y OperationArguments
. OperationSpec
es una traducción de los requisitos de solicitud del archivo OpenAPI/Swagger que describe el servicio.
createClientPipeline
Este método se usa para crear una instancia de Pipeline
personalizada con directivas adicionales que realizan la serialización y la deserialización. La mayor parte del trabajo consiste en convertir las solicitudes en el mensaje HTTP correcto que un servicio espera y, a continuación, convertir la carga de respuesta HTTP en la forma de respuesta descrita por el archivo de especificación OpenAPI del servicio.
Asignadores/createSerializer
Los Mapper
se usan para codificar y descodificar datos en encabezados y cuerpos HTTP. Describen todos los campos de solicitud y respuesta. Los OperationSpec
hacen referencia a ellos.
El método createSerializer
crea un objeto Serializer
que se usa para realizar la mayor parte del trabajo transformando los datos al realizar una solicitud o procesar una respuesta. Dado un corpus de Mapper
y el OperationSpec
adecuado, puede crear un objeto de solicitud HTTP a partir de una entrada proporcionada por el usuario o convertir un objeto de respuesta HTTP en un formulario fácil de usar.
Pasos siguientes
Puede compilar y ejecutar las pruebas localmente ejecutando rushx test
. Explore la carpeta de prueba para ver el uso avanzado y el comportamiento de las clases públicas.
Obtenga más información sobre AutoRest y la extensión autorest.typescript para generar un cliente compatible sobre este paquete.
Solución de problemas
Si tiene problemas al usar esta biblioteca, no dude en presentar un problema.
Contribuciones
Si desea contribuir a esta biblioteca, lea la guía de contribución para obtener más información sobre cómo compilar y probar el código.
Azure SDK for JavaScript