Biblioteka klienta usługi Azure Core Service dla języka JavaScript — wersja 1.9.2
Ta biblioteka ma być używana głównie w kodzie generowanym przez funkcję AutoRest i autorest.typescript
.
Wprowadzenie
Obecnie obsługiwane środowiska
- Wersje ltS Node.js
- Najnowsze wersje przeglądarek Safari, Chrome, Edge i Firefox.
Aby uzyskać więcej informacji, zobacz nasze zasady pomocy technicznej .
Instalacja
Ten pakiet jest używany głównie w generowanym kodzie i nie jest przeznaczony do użycia bezpośrednio przez użytkowników końcowych.
Kluczowe pojęcia
Serviceclient
Jest to wspólna klasa bazowa dla wygenerowanych klientów. Udostępnia metody sendOperationRequest
i sendRequest
.
sendRequest
po prostu wysyła żądanie HTTP przy użyciu elementu Pipeline
(zobacz @azure/core-rest-pipeline
szczegóły).
sendOperationRequest
jest używany przez wygenerowany kod w celu wykonania żądania przy użyciu elementu OperationSpec
i OperationArguments
. Jest OperationSpec
to tłumaczenie wymagań dotyczących żądań z pliku OpenAPI/Swagger opisującego usługę.
createClientPipeline
Ta metoda służy do tworzenia wystąpienia dostosowanego Pipeline
przy użyciu dodatkowych zasad, które wykonują serializacji i deserializacji. Większość pracy polega na konwertowaniu żądań na właściwy komunikat HTTP oczekiwany przez usługę, a następnie konwertowanie ładunku odpowiedzi HTTP na kształt odpowiedzi opisany przez plik specyfikacji OpenAPI usługi.
Mapery /createSerializer
Mapper
s służą do kodowania i dekodowania danych do nagłówków i treści HTTP. Opisują wszystkie pola żądań i odpowiedzi. Odwołuje się do OperationSpec
nich s.
createSerializer
Metoda tworzy Serializer
obiekt używany do wykonywania większości zadań przekształcania danych podczas wysyłania żądania lub przetwarzania odpowiedzi. Biorąc pod uwagę korpus Mapper
s i odpowiednie OperationSpec
może produkować obiekt żądania HTTP od użytkownika dostarczonego danych wejściowych lub przekonwertować obiekt odpowiedzi HTTP na przyjazny dla użytkownika formularz.
Następne kroki
Testy można kompilować i uruchamiać lokalnie, wykonując polecenie rushx test
. Zapoznaj się z folderem testowym , aby zobaczyć zaawansowane użycie i zachowanie klas publicznych.
Dowiedz się więcej na temat funkcji AutoRest i rozszerzenia autorest.typescript do generowania zgodnego klienta na podstawie tego pakietu.
Rozwiązywanie problemów
Jeśli wystąpią problemy podczas korzystania z tej biblioteki, możesz zgłosić problem.
Współtworzenie
Jeśli chcesz współtworzyć tę bibliotekę, przeczytaj przewodnik współtworzenia , aby dowiedzieć się więcej na temat sposobu kompilowania i testowania kodu.
Azure SDK for JavaScript