Klientská knihovna služby Azure Core Service pro JavaScript – verze 1.9.2

Tato knihovna je primárně určena pro použití v kódu generovaném autoRest a autorest.typescript.

Začínáme

Aktuálně podporovaná prostředí

• LtS verze Node.js
• Nejnovější verze prohlížečů Safari, Chrome, Edge a Firefox.

Další podrobnosti najdete v našich zásadách podpory .

Instalace

Tento balíček se primárně používá ve vygenerovaném kódu a není určen k přímému využívání koncovými uživateli.

Klíčové koncepty

ServiceClient

Toto je společná základní třída pro vygenerované klienty. Poskytuje metody sendOperationRequest a sendRequest.

sendRequest jednoduše vytvoří požadavek HTTP pomocí Pipeline (podrobnosti viz @azure/core-rest-pipeline ).

sendOperationRequest se používá vygenerovaným kódem k vytvoření požadavku pomocí OperationSpec a OperationArguments. An OperationSpec je překlad požadavků požadavků ze souboru OpenAPI/Swagger, který službu popisuje.

createClientPipeline

Tato metoda se používá k vytvoření Pipeline instance, která je přizpůsobena další zásady, které provádějí serializaci a deserializaci. Velká část práce spočívá v převodu požadavků na správnou zprávu HTTP, kterou služba očekává, a následném převodu datové části odpovědi HTTP na tvar odpovědi, který popisuje soubor specifikace OpenAPI služby.

Mappers / createSerializer

Mappers se používají ke kódování a dekódování dat do hlaviček a těl HTTP. Popisují všechna pole požadavků a odpovědí. Odkazuje na je s OperationSpec.

Metoda createSerializer vytvoří Serializer objekt , který slouží k provádění velké části práce při transformaci dat při vytváření požadavku nebo zpracování odpovědi. V daném korpusu Mappers a příslušném OperationSpec může vytvořit objekt požadavku HTTP ze vstupu poskytnutého uživatelem nebo převést objekt odpovědi HTTP do uživatelsky přívětivé podoby.

Další kroky

Testy můžete sestavit a spustit místně spuštěním rushx testpříkazu . Prozkoumejte složku test a podívejte se na pokročilé využití a chování veřejných tříd.

Přečtěte si další informace o AutoRest a rozšíření autorest.typescript pro generování kompatibilního klienta nad rámec tohoto balíčku.

Poradce při potížích

Pokud při používání této knihovny narazíte na problémy, neváhejte a nahlaste problém.

Přispívání

Pokud chcete přispívat do této knihovny, přečtěte si příručku pro přispívání , kde najdete další informace o tom, jak sestavit a otestovat kód.