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

Article
05/14/2024

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

Prérequis

Docker
.NET 8
Un client de gestion des données
- Si aucun client n’est installé, installez Azure Data Studio

Conseil

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 de stockage et d’heures de base gratuitement. Pour plus d’informations, consultez Heures de stockage et de cœur incluses 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 avec Microsoft.DataApiBuilder l’argument --global .
```
dotnet tool install --global Microsoft.DataApiBuilder
```
Notes

Si le package est déjà installé, vous allez le mettre à jour à la place à l’aide de dotnet tool update.
```
dotnet tool update --global Microsoft.DataApiBuilder
```
Vérifiez que l’outil est installé avec dotnet tool list à l’aide de 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. Ensuite, vous pouvez amorcer un nouveau conteneur avec des exemples de données.

Obtenez la dernière copie de l’image postgres:16 conteneur à partir de Docker Hub.
```
docker pull postgres:16
```
Démarrez le conteneur Docker en définissant le mot de passe et le port de publication 5432. Remplacez par <your-password> un mot de passe personnalisé.
```
docker run \
    --publish 5432:5432 \
    --env "POSTGRES_PASSWORD=<your-password>" \
    --detach \
    postgres:16
```
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 à : pgAdmin, Azure Data Studio et l’extension PostgreSQL pour Visual Studio Code.

Conseil

Si vous utilisez la mise en réseau par défaut pour vos images conteneur Docker Linux, le chaîne de connexion sera Host=localhost;Port=5432;User ID=postgres;Password=<your-password>;probablement . Remplacez par <your-password> le mot de passe que vous avez défini précédemment.

Créez une base de données bookshelf.

DROP DATABASE IF EXISTS bookshelf;

CREATE DATABASE bookshelf;

Create une nouvelle dbo.authors table et amorcer 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

Create un fichier de configuration de base 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.

Create un fichier de configuration classique à l’aide de dab init. Ajoutez l’argument --connection-string avec votre base de données chaîne de connexion de la première section. Remplacez par <your-password> le mot de passe que vous avez défini précédemment dans ce guide. Ajoutez également la Database=bookshelf valeur à la chaîne de connexion.
```
dab init --database-type "postgresql" --host-mode "Development" --connection-string "Host=localhost;Port=5432;Database=bookshelf;User ID=postgres;Password=<your-password>;"
```

Ajoutez une entité Author à l’aide de dab add.

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

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.

Utilisez dab start pour exécuter l’outil et 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

Dans cet exemple, l’application s’exécute sur le localhost 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

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

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

Partager via