Générateur d’API de données hôtes dans Azure Static Web Apps (préversion)

• Un compte Azure avec un abonnement actif. Créer un compte gratuitement.

• Azure Static Web Apps CLI. installer l’interface CLI Static Web Apps (SWA).

• INTERFACE CLI du générateur d’API de données. installer l’interface CLI DAB (Data API Builder).

• Base de données prise en charge existante accessible à partir d’Azure.

• Application web existante dans un référentiel GitHub qui peut être déployé sur Azure Static Web Apps. - Si vous n’avez pas d’application web, générer un référentiel avec une application web de base.

Pour commencer, utilisez le portail Azure pour créer une application web statique Azure à l’aide de l’application web dans GitHub.

1. Connectez-vous au portail Azure (https://portal.azure.com).

2. Créez un groupe de ressources. Vous allez utiliser ce groupe de ressources pour toutes les nouvelles ressources de ce guide.

   

   Pourboire

   Nous vous recommandons de nommer le groupe de ressources msdocs-dab-swa. Toutes les captures d’écran de ce guide utilisent ce nom.

3. Créez une application web statique Azure. Utilisez ces paramètres pour configurer l’application web statique.

   Réglage	Valeur
   groupe de ressources	Sélectionnez le groupe de ressources que vous avez créé précédemment
   Nom	Entrez un nom global unique
   type de plan	Sélectionnez la meilleure option pour votre charge de travail
   source	Sélectionnez GitHub
   compte GitHub	Configurer un compte GitHub qui a accès au référentiel d’applications web
   organisation	Sélectionnez l’organisation parente ou l’utilisateur du référentiel
   référentiel	Sélectionner le nom du référentiel
   Branche	Sélectionner la branche principale

   

4. Attendez que le déploiement de l’application web statique se termine. Un flux de travail GitHub Actions est automatiquement ajouté à votre référentiel qui déploie l’application sur Azure Static Web Apps chaque fois que vous envoyez (push) à la branche principale.

   Note

   Ce déploiement initial peut prendre quelques minutes. Vous pouvez toujours vérifier l’état du déploiement dans le portail Azure ou l’onglet GitHub Actions de votre référentiel.

5. Accédez à la nouvelle application web statique dans le portail Azure.

6. Dans la section Essentials, utilisez l’URL lien hypertexte pour accéder à l’application web en cours d’exécution. Vérifiez que l’application s’exécute comme prévu.

À présent, utilisez les interfaces de ligne de commande DAB et SWA pour créer un fichier de configuration DAB et l’ajouter au référentiel d’applications web.

1. Ouvrez le dépôt GitHub de votre application web dans l’environnement de développement intégré (IDE) de votre choix.

   Pourboire

   Vous pouvez utiliser n’importe quel IDE souhaité. Si vous souhaitez travailler localement sur l’application, vous pouvez cloner le référentiel sur votre ordinateur local. Si vous préférez travailler dans le navigateur, vous pouvez utiliser GitHub Codespaces. Vérifiez que les API SWA et DAB sont installées dans votre environnement de développement.

2. Ouvrez un terminal à la racine du référentiel.

3. Utilisez la commande swa db à partir de l’interface CLI SWA pour initialiser un nouveau fichier de configuration DAB à l’aide du type de base de données spécifié. La commande crée un fichier nommé staticwebapp.database.config.json dans le dossier swa-db-connections.

   swa db init --database-type "<database-type>"
   

   Important

   Certains types de base de données nécessitent des paramètres de configuration supplémentaires lors de l’initialisation.

4. Utilisez la commande dab add pour ajouter au moins une entité de base de données à la configuration. Configurez chaque entité pour autoriser toutes les autorisations pour les utilisateurs anonymes. Répétez dab add autant de fois que vous le souhaitez pour vos entités.

   dab add "<entity-name>" --source "<schema>.<table>" --permissions "anonymous:*" --config "swa-db-connections/staticwebapp.database.config.json"
   

5. Ouvrez et examinez le contenu du fichier swa-db-connections/staticwebapp.database.config.json.

6. Validez vos modifications dans le référentiel et envoyez-les à la branche primaire. Cela déclenche automatiquement un nouveau déploiement de l’application web. Attendez que ce dernier déploiement se termine avant de continuer avec ce guide.

Ensuite, configurez la connexion de base de données dans le portail Azure pour permettre à l’application web statique d’accéder à la base de données.

1. Accédez à nouveau à l’application web statique dans le portail Azure.

2. Sélectionnez l’option de connexion base de données dans la section paramètres du menu de ressources. Sélectionnez ensuite Lier des de base de données existantes pour l’environnement de production .

   

3. Dans la boîte de dialogue lier la base de données , utilisez ces paramètres pour configurer la connexion de base de données.

   Réglage	Valeur
   type de base de données	Sélectionnez le même type de base de données que celui que vous avez utilisé lors de la création du fichier de configuration DAB
   groupe de ressources	Sélectionnez le groupe de ressources que vous avez créé précédemment dans ce guide
   nom de ressource	Sélectionnez la ressource de base de données à lier à l’application web statique
   nom de base de données	Entrez le nom de la base de données
   type d’authentification	Sélectionnez le type d’authentification que vous envisagez d’utiliser

   

   Pourboire

   Nous vous recommandons d’utiliser une chaîne de connexion qui n’inclut pas de clés d’autorisation. Utilisez plutôt des identités managées et un contrôle d’accès en fonction du rôle pour gérer l’accès entre votre base de données et votre hôte. Pour plus d’informations, consultez services Azure qui utilisent des identités managées.

Enfin, vérifiez que le point de terminaison de l’API de données est disponible sur l’application web statique.

1. Accédez à nouveau à l’application web statique dans le portail Azure.

2. Utilisez le champ URL dans la section Essentials pour accéder à nouveau au site web de l’application web statique.

3. Accédez au chemin d’accès /data-api de l’application en cours d’exécution. Notez que la réponse indique toujours que le conteneur DAB est sain.

   { Healthy }
   

4. Accédez au chemin d’accès https://<your-static-web-app-url>/data-api/<your-rest-path>/<your-entity-name> de l’application en cours d’exécution. Cela émet une requête HTTP GET pour cet ensemble d’entités. Observez la réponse JSON.

Lorsque vous n’avez plus besoin de l’exemple d’application ou de ressources, supprimez le déploiement correspondant et toutes les ressources.

1. Accédez au groupe de ressources à l’aide du portail Azure.

2. Dans la barre de commandes , sélectionnez Supprimer.