Démarrage rapide : Utiliser le générateur d’API de données avec MySQL

Dans ce guide de démarrage rapide, vous générez un ensemble de fichiers de configuration du générateur d’API de données pour cibler une base de données MySQL locale.

Conditions préalables

Conseil / Astuce

Vous pouvez également ouvrir ce guide de démarrage rapide dans GitHub Codespaces avec tous les prérequis pour les développeurs déjà installés. Apportez simplement votre propre abonnement Azure. Les comptes GitHub incluent un droit d’utilisation relatif au stockage et aux heures cœur gratuites. Pour plus d’informations, consultez Stockage et heures cœur inclus pour les comptes GitHub.

Installer l’interface CLI du générateur d’API de données

Installez le Microsoft.DataApiBuilder package à partir de NuGet en tant qu’outil .NET.

Utilisez dotnet tool install pour installer la dernière version de Microsoft.DataApiBuilder avec l'argument --global.
```
dotnet tool install --global Microsoft.DataApiBuilder
```
Remarque

Si le paquet est déjà installé, mettez à jour le paquet à l'aide de dotnet tool update.
```
dotnet tool update --global Microsoft.DataApiBuilder
```
Vérifiez que l'outil est installé avec dotnet tool list en utilisant l'argument --global.
```
dotnet tool list --global
```

Configurer la base de données locale

Commencez par configurer et exécuter la base de données locale. Vous pouvez ensuite amorcer un nouveau conteneur avec des données d'exemple.

Obtenez la dernière version de l’image de conteneur mysql:8 depuis Docker Hub.
```
docker pull mysql:8
```
Démarrez le conteneur Docker en définissant le mot de passe et le port de publication 3306. Remplacez par <your-password> un mot de passe personnalisé.
```
docker run \
    --publish 3306:3306 \
    --env "MYSQL_ROOT_PASSWORD=<your-password>" \
    --detach \
    mysql:8
```
Connectez-vous à votre base de données locale à l’aide de votre environnement de gestion des données préféré. Les exemples incluent, mais ne sont pas limités à : MySQL Workbench et l’interpréteur de commandes MySQL pour Visual Studio Code.

Conseil / Astuce

Si vous utilisez le réseau par défaut pour vos images de conteneur Docker Linux, la chaîne de connexion sera probablement Server=localhost;Port=3306;Uid=root;Pwd=<your-password>;. Remplacez <your-password> par le mot de passe que vous avez défini précédemment.
Créez une bookshelf base de données et utilisez la base de données pour vos requêtes restantes.
```
CREATE DATABASE IF NOT EXISTS bookshelf;

USE bookshelf;
```

Créez une nouvelle dbo.authors table et remplissez la table avec des données de base.

CREATE TABLE IF NOT EXISTS authors
(
    id INT NOT NULL PRIMARY KEY,
    first_name VARCHAR(100) NOT NULL,
    middle_name VARCHAR(100),
    last_name VARCHAR(100) NOT NULL
);

INSERT INTO authors VALUES
    (01, 'Henry', NULL, 'Ross'),
    (02, 'Jacob', 'A.', 'Hancock'),
    (03, 'Sydney', NULL, 'Mattos'),
    (04, 'Jordan', NULL, 'Mitchell'),
    (05, 'Victoria', NULL, 'Burke'),
    (06, 'Vance', NULL, 'DeLeon'),
    (07, 'Reed', NULL, 'Flores'),
    (08, 'Felix', NULL, 'Henderson'),
    (09, 'Avery', NULL, 'Howard'),
    (10, 'Violet', NULL, 'Martinez');

Créer les fichiers de configuration

Créez un fichier de configuration de référence à l’aide de l’interface CLI DAB. Ensuite, ajoutez un fichier de configuration de développement avec vos informations d’identification actuelles.

Créez un fichier de configuration classique à l’aide de dab init. Ajoutez l’argument --connection-string avec votre chaîne de connexion de base de données à partir de la première section. Remplacez <your-password> par le mot de passe que vous définissez précédemment dans ce guide. Ajoutez également la Database=bookshelf valeur à la chaîne de connexion.
```
dab init --database-type "mysql" --host-mode "Development" --connection-string "Server=localhost;Port=3306;Database=bookshelf;Uid=root;Pwd=<your-password>;"
```

Ajoutez une entité Author à l’aide dab addde .

dab add Author --source "authors" --permissions "anonymous:*"

Observez votre fichier de configurationdab-config.json actuel. Le fichier doit inclure une implémentation de référence de votre API avec une seule entité, un point de terminaison d’API REST et un point de terminaison GraphQL.

Tester l’API avec la base de données locale

À présent, démarrez l’outil Générateur d’API de données pour vérifier que vos fichiers de configuration sont fusionnés pendant le développement.

Permet dab start d’exécuter l’outil et de créer des points de terminaison d’API pour votre entité.
```
dab start
```
La sortie de l’outil doit inclure l’adresse à utiliser pour accéder à l’API en cours d’exécution.
```
      Successfully completed runtime initialization.
info: Microsoft.Hosting.Lifetime[14]
      Now listening on: <http://localhost:5000>
info: Microsoft.Hosting.Lifetime[0]
```
Conseil / Astuce

Dans cet exemple, l’application s’exécute sur localhost le port 5000. Votre application en cours d’exécution peut avoir une adresse et un port différents.
Tout d’abord, essayez l’API manuellement en émettant une requête GET à /api/Author.

Conseil / Astuce

Dans cet exemple, l’URL serait https://localhost:5000/api/Author. Vous pouvez accéder à cette URL à l’aide de votre navigateur web.
Ensuite, accédez à la page de documentation Swagger à l’adresse /swagger.

Conseil / Astuce

Dans cet exemple, l’URL serait https://localhost:5000/swagger. Là encore, vous pouvez accéder à cette URL à l’aide de votre navigateur web.

Étape suivante

points de terminaison REST

Commentaires

Cette page a-t-elle été utile ?

Last updated on 2025-07-17