Esercitazione: Aggiungere una connessione al database Azure Cosmos DB in App Web statiche di Azure (anteprima)

  • Articolo

Questa esercitazione descrive come connettere un database Azure Cosmos DB per NoSQL all'app Web statica. Dopo la configurazione, è possibile inviare richieste GraphQL all'endpoint predefinito per modificare i dati senza dover scrivere codice back-end /data-api .

Per semplicità, questa esercitazione illustra come usare un database di Azure a scopo di sviluppo locale, ma è anche possibile usare un server di database locale per le esigenze di sviluppo locali.

Nota

Questa esercitazione illustra come usare Azure Cosmos DB per NoSQL. Per usare un altro database, vedere le esercitazioni su Azure SQL, MySQL o PostgreSQL.

Web browser che mostra i risultati di Cosmos DB nella finestra della console degli strumenti di sviluppo.

In questa esercitazione si apprenderà come:

  • Collegare un database Azure Cosmos DB per NoSQL all'app Web statica
  • Creare, leggere, aggiornare ed eliminare dati

Prerequisiti

Per completare questa esercitazione, è necessario avere un database Di Azure Cosmos DB per NoSQL esistente e un'app Web statica.

Risorsa Descrizione
Database Di Azure Cosmos DB per NoSQL Se non è già disponibile, seguire la procedura descritta nella guida Creare un database Azure Cosmos DB .
App Web statica esistente Se non è già disponibile, seguire la procedura descritta nella guida introduttiva per creare un'app Web statica No Framework .

Per iniziare, configurare il database in modo che funzioni con la funzionalità di connessione al database App Web statiche di Azure.

Configurare la connettività del database

App Web statiche di Azure deve avere accesso di rete al database per consentire il funzionamento delle connessioni al database. Inoltre, per usare un database di Azure per lo sviluppo locale, è necessario configurare il database per consentire le richieste provenienti dal proprio indirizzo IP.

  1. Passare all'account Azure Cosmos DB per NoSQL nel portale di Azure.

  2. Nella sezione Impostazioni selezionare Rete.

  3. Nella sezione Accesso pubblico selezionare Tutte le reti. Questa azione consente di usare il database cloud per lo sviluppo locale, che la risorsa App Web statiche distribuita può accedere al database e che è possibile eseguire query sul database dal portale.

  4. Selezionare Salva.

Ottenere la stringa di connessione del database per lo sviluppo locale

Per usare il database di Azure per lo sviluppo locale, è necessario recuperare la stringa di connessione del database. È possibile ignorare questo passaggio se si prevede di usare un database locale a scopo di sviluppo.

  1. Passare all'account Azure Cosmos DB per NoSQL nel portale di Azure.

  2. Nella sezione Impostazioni selezionare Chiavi.

  3. Nella casella STRINGA DI CONNESSIONE PRIMARIA copiare la stringa di connessione e salvarla in un editor di testo.

Creare dati di esempio

Creare una tabella di esempio e eseguire il seeding con i dati di esempio in modo che corrispondano all'esercitazione.

  1. Nella finestra di spostamento a sinistra selezionare Esplora dati.

  2. Selezionare Nuovo contenitore. Immettere l'ID database come Create newe immettere MyTestPersonDatabase come valore.

  3. Immettere l'ID contenitore di MyTestPersonContainer.

  4. Immettere una chiave di partizione di id (questo valore è preceduto da /).

  5. Selezionare OK.

  6. Selezionare il contenitore MyTestPersonContainer .

  7. Selezionare i relativi elementi.

  8. Selezionare Nuovo elemento e immettere il valore seguente:

    {
    "id": "1",
    "Name": "Sunny"
}

Configurare l'app Web statica

La parte restante di questa esercitazione è incentrata sulla modifica del codice sorgente dell'app Web statica per l'uso delle connessioni di database in locale.

Importante

I passaggi seguenti presuppongono che si stia usando l'app Web statica creata nella guida introduttiva. Se si usa un progetto diverso, assicurarsi di modificare i comandi Git seguenti in modo che corrispondano ai nomi dei rami.

  1. Passare al ramo main.

    git checkout main

  2. Sincronizzare la versione locale con gli elementi in GitHub usando git pull.

    git pull origin main

Creare il file di configurazione del database

Creare quindi il file di configurazione usato dall'app Web statica per interfacciarsi con il database.

  1. Aprire il terminale e creare una nuova variabile per contenere la stringa di connessione. La sintassi specifica può variare a seconda del tipo di shell in uso.

    export DATABASE_CONNECTION_STRING='<YOUR_CONNECTION_STRING>'

    Assicurarsi di sostituire <YOUR_CONNECTION_STRING> con il valore della stringa di connessione impostato in un editor di testo.

  2. Usare npm per installare o aggiornare l'interfaccia della riga di comando di App Web statiche. Selezionare il comando migliore per la situazione.

    Per eseguire l'installazione, usare npm install.

    npm install -g @azure/static-web-apps-cli

    Per eseguire l'aggiornamento, usare npm update.

    npm update

  3. Usare il swa db init comando per generare un file di configurazione del database.

    swa db init --database-type cosmosdb_nosql --cosmosdb_nosql-database MyTestPersonDatabase

    Il init comando crea il file staticwebapp.database.config.json nella cartella swa-db-connections .

  4. Incollare questo schema di esempio nel file staticwebapp.database.schema.gql generato.

    Poiché Cosmos DB per NoSQL è un database indipendente dallo schema, App Web statiche di Azure le connessioni al database non possono estrarre lo schema del database. Il file staticwebapp.database.schema.gql consente di specificare lo schema del database Cosmos DB per NoSQL per App Web statiche.

    type Person @model {
  id: ID
  Name: String
}

  5. Incollare questa configurazione di esempio nel file staticwebapp.database.config.json generato. Si noti che Cosmos DB per NoSQL include altre opzioni nell'oggetto data-source per indicare il database Cosmos DB e il file di schema necessario per le connessioni di database per comprendere lo schema del database.

{
  "$schema": "https://github.com/Azure/data-api-builder/releases/latest/download/dab.draft.schema.json",
  "data-source": {
    "database-type": "cosmosdb_nosql",
    "options": {
      "database": "MyTestPersonDatabase",
      "schema": "staticwebapp.database.schema.gql"
    },
    "connection-string": "@env('DATABASE_CONNECTION_STRING')"
  },
  "runtime": {
    "graphql": {
      "allow-introspection": true,
      "enabled": true,
      "path": "/graphql"
    },
    "host": {
      "mode": "production",
      "cors": {
        "origins": ["http://localhost:4280"],
        "allow-credentials": false
      },
      "authentication": {
        "provider": "StaticWebApps"
      }
    }
  },
  "entities": {
    "Person": {
      "source": "MyTestPersonContainer",
      "permissions": [
        {
          "actions": ["*"],
          "role": "anonymous"
        }
      ]
    }
  }
}

Prima di passare al passaggio successivo, esaminare la tabella seguente che illustra i diversi aspetti del file di configurazione. Per la documentazione completa sul file di configurazione e sulle funzionalità, ad esempio relazioni e criteri per la sicurezza a livello di elemento, vedere la documentazione di Generatore API dati.

Feature Spiegazione
Connessione del database In fase di sviluppo, il runtime legge la stringa di connessione dal valore della stringa di connessione nel file di configurazione. Sebbene sia possibile specificare la stringa di connessione direttamente nel file di configurazione, è consigliabile archiviare le stringhe di connessione in una variabile di ambiente locale. È possibile fare riferimento ai valori delle variabili di ambiente nel file di configurazione tramite la @env('DATABASE_CONNECTION_STRING') notazione . Il valore della stringa di connessione viene sovrascritto da App Web statiche per il sito distribuito con le informazioni raccolte quando si connette il database.
Endpoint API L'endpoint GraphQL è disponibile tramite /data-api/graphql come configurato in questo file di configurazione. È possibile configurare il percorso GraphQL, ma il /data-api prefisso non è configurabile.
Sicurezza API Le runtime.host.cors impostazioni consentono di definire le origini consentite che possono effettuare richieste all'API. In questo caso, la configurazione riflette un ambiente di sviluppo e consente di specificare il http://localhost:4280 percorso.
Modello di entità Definisce le entità esposte tramite route come tipi nello schema GraphQL. In questo caso, il nome Person è il nome esposto all'endpoint mentre entities.<NAME>.source è lo schema del database e il mapping delle tabelle. Si noti che il nome dell'endpoint API non deve essere identico al nome della tabella.
Sicurezza delle entità Le regole di autorizzazione elencate nella entity.<NAME>.permissions matrice controllano le impostazioni di autorizzazione per un'entità. È possibile proteggere un'entità con ruoli nello stesso modo in cui si proteggono le route con i ruoli.

Nota

Le proprietà , host.modee graphql.allow-introspection del file di connection-stringconfigurazione vengono sovrascritte quando si distribuisce il sito. La stringa di connessione viene sovrascritta con i dettagli di autenticazione raccolti quando si connette il database alla risorsa App Web statiche. La host.mode proprietà è impostata su productione l'oggetto graphql.allow-introspection è impostato su false. Queste sostituzioni forniscono coerenza nei file di configurazione nei carichi di lavoro di sviluppo e produzione, assicurando che la risorsa App Web statiche con connessioni di database abilitate sia sicura e pronta per la produzione.

Con l'app Web statica configurata per connettersi al database, è ora possibile verificare la connessione.

Aggiornamento home page

Sostituire il markup tra i body tag nel file index.html con il codice HTML seguente.

<h1>Static Web Apps Database Connections</h1>
<blockquote>
    Open the console in the browser developer tools to see the API responses.
</blockquote>
<div>
    <button id="list" onclick="list()">List</button>
    <button id="get" onclick="get()">Get</button>
    <button id="update" onclick="update()">Update</button>
    <button id="create" onclick="create()">Create</button>
    <button id="delete" onclick="del()">Delete</button>
</div>
<script>
    // add JavaScript here
</script>

Avviare l'applicazione in locale

È ora possibile eseguire direttamente il sito Web e modificare i dati nel database.

  1. Usare npm per installare o aggiornare l'interfaccia della riga di comando di App Web statiche. Selezionare il comando migliore per la situazione.

    Per installare, usare npm install.

    npm install -g @azure/static-web-apps-cli

    Per aggiornare, usare npm update.

    npm update

  2. Avviare l'app Web statica con la configurazione del database.

    swa start ./src --data-api-location swa-db-connections

Dopo aver avviato l'interfaccia della riga di comando, è possibile accedere al database tramite gli endpoint definiti nel file staticwebapp.database.config.json .

L'endpoint http://localhost:4280/data-api/graphql accetta query graphQL e mutazioni.

Manipolare i dati

I comandi framework-agnostic seguenti illustrano come eseguire operazioni CRUD complete nel database.

L'output per ogni funzione viene visualizzato nella finestra della console del browser.

Aprire gli strumenti di sviluppo premendo CMD/CTRL + MAIUSC + I e selezionare la scheda Console .

Elencare tutti gli elementi

Aggiungere il codice seguente tra i script tag in index.html.

async function list() {

  const query = `
      {
        people {
          items {
            id
            Name
          }
        }
      }`;
      
  const endpoint = "/data-api/graphql";
  const response = await fetch(endpoint, {
      method: "POST",
      headers: { "Content-Type": "application/json" },
      body: JSON.stringify({ query: query })
  });
  const result = await response.json();
  console.table(result.data.people.items);
}

Esempio:

  • La query GraphQL seleziona i Id campi e Name dal database.
  • La richiesta passata al server richiede un payload in cui la query proprietà contiene la definizione di query.
  • I dati nel payload della risposta si trovano nella data.people.items proprietà .

Aggiornare la pagina e selezionare il pulsante Elenco .

La finestra della console del browser visualizza ora una tabella che elenca tutti i record nel database.

id Nome
1 Sunny
2 Dheeraj

Ecco uno screenshot di ciò che dovrebbe essere simile nel browser.

Web browser che mostra i risultati da una selezione di database nella finestra della console degli strumenti di sviluppo.

Ottenere in base all'ID

Aggiungere il codice seguente tra i script tag in index.html.

async function get() {

  const id = '1';

  const gql = `
    query getById($id: ID!) {
      person_by_pk(id: $id) {
        id
        Name
      }
    }`;

  const query = {
    query: gql,
    variables: {
      id: id,
    },
  };

  const endpoint = "/data-api/graphql";
  const response = await fetch(endpoint, {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify(query),
  });
  const result = await response.json();
  console.table(result.data.person_by_pk);
}

Esempio:

  • La query GraphQL seleziona i id campi e Name dal database.
  • La richiesta passata al server richiede un payload in cui la query proprietà contiene la definizione di query.
  • I dati nel payload della risposta si trovano nella data.person_by_pk proprietà .

Aggiornare la pagina e selezionare il pulsante Recupera .

La finestra della console del browser visualizza ora una tabella che elenca il singolo record richiesto dal database.

id Nome
1 Sunny

Aggiornamento

Aggiungere il codice seguente tra i script tag in index.html.

async function update() {

  const id = '1';
  const data = {
    id: id,
    Name: "Molly"
  };

  const gql = `
    mutation update($id: ID!, $_partitionKeyValue: String!, $item: UpdatePersonInput!) {
      updatePerson(id: $id, _partitionKeyValue: $_partitionKeyValue, item: $item) {
        id
        Name
      }
    }`;

  const query = {
    query: gql,
    variables: {
      id: id,
      _partitionKeyValue: id,
      item: data
    } 
  };

  const endpoint = "/data-api/graphql";
  const res = await fetch(endpoint, {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify(query)
  });

  const result = await res.json();
  console.table(result.data.updatePerson);
}

Esempio:

  • La query GraphQL seleziona i id campi e Name dal database.
  • L'oggetto query contiene la query GraphQL nella query proprietà .
  • I valori degli argomenti della funzione GraphQL vengono passati tramite la query.variables proprietà .
  • La richiesta passata al server richiede un payload in cui la query proprietà contiene la definizione di query.
  • I dati nel payload della risposta si trovano nella data.updatePerson proprietà .

Aggiornare la pagina e selezionare il pulsante Aggiorna .

La finestra della console del browser visualizza ora una tabella che mostra i dati aggiornati.

id Nome
1 Molly

Crea

Aggiungere il codice seguente tra i script tag in index.html.

async function create() {

  const data = {
    id: "3",
    Name: "Pedro"
  };

  const gql = `
    mutation create($item: CreatePersonInput!) {
      createPerson(item: $item) {
        id
        Name
      }
    }`;
  
  const query = {
    query: gql,
    variables: {
      item: data
    } 
  };
  
  const endpoint = "/data-api/graphql";
  const result = await fetch(endpoint, {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify(query)
  });

  const response = await result.json();
  console.table(response.data.createPerson);
}

Esempio:

  • La query GraphQL seleziona i id campi e Name dal database.
  • L'oggetto query contiene la query GraphQL nella query proprietà .
  • I valori degli argomenti della funzione GraphQL vengono passati tramite la query.variables proprietà .
  • La richiesta passata al server richiede un payload in cui la query proprietà contiene la definizione di query.
  • I dati nel payload della risposta si trovano nella data.updatePerson proprietà .

Aggiornare la pagina e selezionare il pulsante Crea .

La finestra della console del browser visualizza ora una tabella che mostra il nuovo record nel database.

id Nome
3 Pedro

Elimina

Aggiungere il codice seguente tra i script tag in index.html.

async function del() {

  const id = '3';

  const gql = `
    mutation del($id: ID!, $_partitionKeyValue: String!) {
      deletePerson(id: $id, _partitionKeyValue: $_partitionKeyValue) {
        id
      }
    }`;

  const query = {
    query: gql,
    variables: {
      id: id,
    _partitionKeyValue: id
    }
  };

  const endpoint = "/data-api/graphql";
  const response = await fetch(endpoint, {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify(query)
  });

  const result = await response.json();
  console.log(`Record deleted: ${ JSON.stringify(result.data) }`);
}

Esempio:

  • La query GraphQL seleziona il Id campo dal database.
  • L'oggetto query contiene la query GraphQL nella query proprietà .
  • I valori degli argomenti della funzione GraphQL vengono passati tramite la query.variables proprietà .
  • La richiesta passata al server richiede un payload in cui la query proprietà contiene la definizione di query.
  • I dati nel payload della risposta si trovano nella data.deletePerson proprietà .

Aggiornare la pagina e selezionare il pulsante Elimina .

La finestra della console del browser visualizza ora una tabella che mostra la risposta dalla richiesta di eliminazione.

Record eliminato: 2

Dopo aver lavorato con il sito in locale, è ora possibile distribuirlo in Azure.

Distribuire il sito

Per distribuire questo sito in produzione, è sufficiente eseguire il commit del file di configurazione e eseguire il push delle modifiche al server.

  1. Eseguire il commit delle modifiche di configurazione.

    git commit -am "Add database configuration"

  2. Eseguire il push delle modifiche al server.

    git push origin main

  3. Attendere che l'app Web venga compilata.

  4. Passare all'app Web statica nel browser.

  5. Selezionare il pulsante Elenco per elencare tutti gli elementi.

    L'output dovrebbe essere simile a quello visualizzato in questo screenshot.

    Web browser che mostra i risultati dell'elenco dei record dal database nella finestra della console degli strumenti di sviluppo.

Connettere il database all'app Web statica

Seguire questa procedura per creare una connessione tra l'istanza App Web statiche del sito e il database.

  1. Aprire l'app Web statica nel portale di Azure.

  2. Nella sezione Impostazioni selezionare Connessione database.

  3. Nella sezione Produzione selezionare il collegamento Collegamento al database esistente .

  4. Nella finestra Collegamento database esistente immettere i valori seguenti:

    Proprietà Valore
    Tipo di database Selezionare il tipo di database dall'elenco a discesa.
    Subscription Selezionare la sottoscrizione di Azure dall'elenco a discesa.
    Nome database Selezionare il nome del database da collegare all'app Web statica.
    Tipo di autenticazione Selezionare Stringa di connessione.

  5. Selezionare OK.

Verificare che il database sia connesso alla risorsa App Web statiche

Dopo aver connesso il database all'app Web statica e al termine della compilazione del sito, seguire questa procedura per verificare la connessione al database.

  1. Aprire l'app Web statica nel portale di Azure.

  2. Nella sezione Essentials selezionare l'URL della risorsa App Web statiche per passare all'app Web statica.

  3. Selezionare il pulsante Elenco per elencare tutti gli elementi.

    L'output dovrebbe essere simile a quello visualizzato in questo screenshot.

    Web browser che mostra i risultati dell'elenco dei record dal database nella finestra della console degli strumenti di sviluppo.

Pulire le risorse

Per rimuovere le risorse create durante questa esercitazione, è necessario scollegare il database e rimuovere i dati di esempio.

  1. Scollegare il database: aprire l'app Web statica nel portale di Azure. Nella sezione Impostazioni selezionare Connessione database. Accanto al database collegato selezionare Visualizza dettagli. Nella finestra Dettagli connessione database selezionare il pulsante Annulla collegamento .

  2. Rimuovere i dati di esempio: nel database eliminare la tabella denominata MyTestPersonContainer.

Passaggi successivi

Aggiungere un'API