Condividi tramite

Libreria client modello di Azure per JavaScript - versione 1.0.0-beta.1

  • Articolo

Questo progetto viene usato come pacchetto di modello per Azure SDK per JavaScript. È destinato a aiutare gli sviluppatori di Azure SDK ad avviare nuovi pacchetti e fornisce un esempio di come organizzare il codice e la documentazione di una libreria client per un servizio di Azure.

Introduzione

Ambienti attualmente supportati

Per altre informazioni, vedere i criteri di supporto.

Prerequisiti

In genere si inserisce un comando shell per effettuare il provisioning dei servizi di Azure necessari qui.

Installare il pacchetto @azure/template

Installare la libreria client modello per JavaScript con npm:

npm install @azure/template

Supporto browser

JavaScript Bundle

Per usare questa libreria client nel browser, è prima necessario usare un bundler. Per informazioni dettagliate su come eseguire questa operazione, vedere la documentazione di raggruppamento.

CORS

È necessario configurare regole corS (Cross-Origin Resource Sharing) per l'account di archiviazione se è necessario sviluppare per i browser. Passare a portale di Azure e Azure Storage Explorer, trovare l'account di archiviazione, creare nuove regole CORS per i servizi BLOB/queue/file/table.

Ad esempio, è possibile creare le impostazioni CORS seguenti per il debug. Ma personalizzare attentamente le impostazioni in base ai requisiti in un ambiente di produzione.

  • Origini consentite: *
  • Verbi consentiti: DELETE,GET,HEAD,MERGE,POST,OPTIONS,PUT
  • Intestazioni consentite: *
  • Intestazioni esposte: *
  • Età massima (secondi): 86400

Altri esempi

Gli esempi di primo livello in genere includono cose come la creazione e l'autenticazione del client principale. Se il servizio supporta più mezzi di autenticazione (ad esempio, basati su chiavi e Azure Active Directory) è possibile fornire un esempio separato di ognuno.

Concetti chiave

ConfigurationClient

Descrivere qui il client primario. Parlare delle operazioni che può eseguire e quando uno sviluppatore vuole usarlo.

Esempi aggiuntivi

Creare una sezione per ogni concetto di servizio di primo livello che si vuole spiegare.

Esempio

Primo esempio

Creare diversi esempi di codice per come un utente userebbe la libreria per eseguire un'attività comune con il servizio.

Risoluzione dei problemi

Registrazione

L'abilitazione della registrazione consente di individuare informazioni utili sugli errori. Per visualizzare un log di richieste e risposte HTTP, impostare la variabile di ambiente AZURE_LOG_LEVEL su info. In alternativa, la registrazione può essere abilitata in fase di esecuzione chiamando setLogLevel in @azure/logger:

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

setLogLevel("info");

Per istruzioni più dettagliate su come abilitare i log, è possibile esaminare la documentazione del pacchetto @azure/logger.

Passaggi successivi

Esaminare la directory degli esempi per esempi dettagliati che illustrano come usare le librerie client.

Contributo

Per contribuire a questa libreria, leggere la guida ai contributi per altre informazioni su come compilare e testare il codice.

Impression