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

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

Prise en main

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 politique de support .

Installation

Ce package est principalement utilisé dans le code généré ; il 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. Elle 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 d’un OperationArguments. Un OperationSpec est une traduction des exigences de requête du fichier OpenAPI/Swagger qui décrit le service.

createClientPipeline

Cette méthode s’utilise pour créer une instance de Pipeline qui est personnalisée avec des stratégies supplémentaires pour 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 à convertir 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

Les Mapper sont utilisés pour encoder et décoder les données dans les corps et en-têtes HTTP. Ils décrivent tous les champs de requête et de réponse. Ils sont référencés par des OperationSpec.

La méthode createSerializer crée une méthode Serializer qui est utilisée pour effectuer la majeure partie du travail de transformation des données au moment de l’envoi d’une requête ou du traitement d’une réponse. Avec un corpus de Mapper et le OperationSpec approprié, elle peut construire un objet de requête HTTP à partir d’une entrée utilisateur ou convertir un objet de réponse HTTP dans un formulaire lisible par l’utilisateur.

Étapes suivantes

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

Découvrez-en plus sur AutoRest et l’extension autorest.typescript pour générer un client compatible sur ce package.

Résolution des problèmes

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

Contribution

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.