Bibliothèque cliente Azure Core Service pour JavaScript - version 1.10.1

Cette bibliothèque est principalement destinée à être utilisée dans le code généré par autorest et autorest.typescript.

Commencer

Environnements actuellement pris en charge

• versions LTS de Node.js
• Dernières versions de Safari, Chrome, Edge et Firefox.

Pour plus d’informations, consultez notre de stratégie de support.

Installation

Ce package est principalement utilisé dans le code généré et n’est pas destiné à être consommé directement par les utilisateurs finaux.

Concepts clés

ServiceClient

Il s’agit de la classe de base commune pour les clients générés. Il fournit les méthodes sendOperationRequest et sendRequest.

sendRequest effectue simplement une requête HTTP à l’aide d’un Pipeline (voir @azure/core-rest-pipeline pour plus d’informations.)

sendOperationRequest est utilisé par le code généré pour effectuer une requête à l’aide d’un OperationSpec et de OperationArguments. Une OperationSpec est une traduction des exigences de requête du fichier OpenAPI/Swagger qui décrit le service.

createClientPipeline

Cette méthode est utilisée pour créer une instance de Pipeline personnalisée avec des stratégies supplémentaires qui effectuent la sérialisation et la désérialisation. La majeure partie du travail consiste à convertir des requêtes en message HTTP approprié attendu par un service, puis en convertissant la charge utile de réponse HTTP en forme de réponse décrite par le fichier de spécification OpenAPI du service.

Mappeurs / createSerializer

Mappers sont utilisés pour encoder et décoder des données dans des en-têtes et des corps HTTP. Ils décrivent tous les champs de demande et de réponse. Elles sont référencées par OperationSpecs.

La méthode createSerializer crée une Serializer utilisée pour effectuer la majeure partie du travail de transformation des données lors de la création d’une demande ou d’un traitement d’une réponse. Étant donné un corpus de Mappers et le OperationSpec approprié, il peut fabriquer un objet de requête HTTP à partir d’une entrée fournie par l’utilisateur ou convertir un objet de réponse HTTP en formulaire convivial.

Étapes suivantes

Vous pouvez générer et exécuter les tests localement en exécutant npm run test. Explorez le dossier de test pour voir l’utilisation et le comportement avancés des classes publiques.

En savoir plus sur AutoRest et l’extension autorest.typescript pour générer un client compatible au-dessus de ce package.

Dépannage

Si vous rencontrez des problèmes lors de l’utilisation de cette bibliothèque, n’hésitez pas à fichier un problème.

Contribuant

Si vous souhaitez contribuer à cette bibliothèque, lisez le guide de contribution pour en savoir plus sur la génération et le test du code.