Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
Diese Bibliothek soll in erster Linie in Code verwendet werden, der von AutoRest- und autorest.typescriptgeneriert wird.
Erste Schritte
Derzeit unterstützte Umgebungen
- LTS-Versionen von Node.js
- Neueste Versionen von Safari, Chrome, Edge und Firefox.
Weitere Informationen finden Sie in unserer Supportrichtlinie.
Einrichtung
Dieses Paket wird in erster Linie in generierten Code verwendet und sollte nicht direkt von Endbenutzern genutzt werden.
Schlüsselkonzepte
ServiceClient
Dies ist die allgemeine Basisklasse für generierte Clients. Sie stellt die Methoden sendOperationRequest und sendRequestbereit.
sendRequest führt einfach eine HTTP-Anfrage mit einem Pipeline (siehe @azure/core-rest-pipeline Details.)
sendOperationRequest wird von generiertem Code verwendet, um eine Anfrage mit einem OperationSpec und OperationArgumentszu erstellen. Ein OperationSpec ist eine Übersetzung der Anforderungsanforderungen aus der OpenAPI/Swagger-Datei, die den Dienst beschreibt.
createClientPipeline
Diese Methode wird verwendet, um eine Pipeline Instanz zu erstellen, die mit zusätzlichen Richtlinien angepasst wird, die Serialisierung und Deserialisierung durchführen. Der Großteil der Arbeit besteht darin, Anforderungen in die richtige HTTP-Nachricht zu konvertieren, die ein Dienst erwartet und dann die HTTP-Antwortnutzlast in das Antwort-Shape konvertiert, das von der OpenAPI-Spezifikationsdatei des Diensts beschrieben wird.
Mappers /createSerializer
Mappers werden verwendet, um Daten in HTTP-Header und -Bodies zu codieren und zu dekodieren. Sie beschreiben alle Anforderungs- und Antwortfelder. Sie werden von OperationSpecs referenziert.
Die Methode createSerializer erstellt eine Serializer, die verwendet wird, um den Großteil der Arbeitstransformationsdaten beim Senden einer Anforderung oder Verarbeitung einer Antwort zu erledigen. Aufgrund eines Korpus von Mapperund der entsprechenden OperationSpec kann es ein HTTP-Anforderungsobjekt aus einer vom Benutzer bereitgestellten Eingabe herstellen oder ein HTTP-Antwortobjekt in eine benutzerfreundliche Form konvertieren.
Nächste Schritte
Sie können die Tests lokal erstellen und ausführen, indem Sie npm run testausführen. Erkunden Sie den -Testordner Ordners, um die erweiterte Verwendung und das Verhalten der öffentlichen Klassen anzuzeigen.
Erfahren Sie mehr über den TypeSpec-Emitter@azure-tools/typespec-ts zur Generierung eines kompatiblen Clients auf diesem Paket.
Fehlerbehebung
Wenn bei der Verwendung dieser Bibliothek Probleme auftreten, Sie ein Problem.
Beitragend
Wenn Sie an dieser Bibliothek mitwirken möchten, lesen Sie bitte den mitwirkenden Leitfaden, um mehr über das Erstellen und Testen des Codes zu erfahren.
Azure SDK for JavaScript