Dela via

Azure Template-klientbibliotek för JavaScript – version 1.0.0-beta.1

  • Artikel

Det här projektet används som ett mallpaket för Azure SDK för JavaScript. Den är avsedd att hjälpa Azure SDK-utvecklare att starta nya paket och ger ett exempel på hur du organiserar koden och dokumentationen för ett klientbibliotek för en Azure-tjänst.

Komma igång

Miljöer som stöds för närvarande

Mer information finns i vår supportpolicy .

Förutsättningar

Vanligtvis skulle du placera ett gränssnittskommando för att etablera nödvändiga Azure-tjänster här.

Installera @azure/template-paketet

Installera mallklientbiblioteket för JavaScript med npm:

npm install @azure/template

Stöd för webbläsare

JavaScript-paket

Om du vill använda det här klientbiblioteket i webbläsaren måste du först använda en bundler. Mer information om hur du gör detta finns i vår paketeringsdokumentation.

CORS

Du måste konfigurera CORS-regler (Cross-Origin Resource Sharing) för ditt lagringskonto om du behöver utveckla för webbläsare. Gå till Azure Portal och Azure Storage Explorer, leta upp ditt lagringskonto, skapa nya CORS-regler för blob/kö/fil/tabelltjänster.

Du kan till exempel skapa följande CORS-inställningar för felsökning. Men anpassa inställningarna noggrant enligt dina krav i en produktionsmiljö.

  • Tillåtet ursprung: *
  • Tillåtna verb: DELETE,GET,HEAD,MERGE,POST,OPTIONS,PUT
  • Tillåtna rubriker: *
  • Exponerade rubriker: *
  • Maximal ålder (sekunder): 86400

Ytterligare exempel

Exempel på toppnivå omfattar vanligtvis saker som att skapa och autentisera huvudklienten. Om din tjänst stöder flera sätt att autentisera (t.ex. nyckelbaserad och Azure Active Directory) kan du ge ett separat exempel på var och en.

Viktiga begrepp

ConfigurationClient

Beskriv din primära klient här. Prata om vilka åtgärder den kan göra och när en utvecklare vill använda den.

Ytterligare exempel

Skapa ett avsnitt för varje servicekoncept på den översta nivån som du vill förklara.

Exempel

Första exemplet

Skapa flera kodexempel för hur någon skulle använda ditt bibliotek för att utföra en gemensam uppgift med tjänsten.

Felsökning

Loggning

Aktivering av loggning kan hjälpa dig att hitta användbar information om fel. Om du vill se en logg över HTTP-begäranden och svar anger du AZURE_LOG_LEVEL miljövariabeln till info. Loggning kan också aktiveras vid körning genom att anropa setLogLevel i @azure/logger:

const { setLogLevel } = require("@azure/logger");

setLogLevel("info");

Mer detaljerade anvisningar om hur du aktiverar loggar finns i dokumentationen om @azure-/loggningspaket.

Nästa steg

Ta en titt på exempelkatalogen för detaljerade exempel som visar hur du använder klientbiblioteken.

Bidra

Om du vill bidra till det här biblioteket kan du läsa bidragsguiden om du vill veta mer om hur du skapar och testar koden.

Visningar