Hızlı Başlangıç: PostgreSQL ile Veri API oluşturucusu kullanma

Bu Hızlı Başlangıçta, yerel bir PostgreSQL veritabanını hedeflemek için bir dizi Veri API'si oluşturucu yapılandırma dosyası oluşturacaksınız.

Önkoşullar

• Docker
• .NET 8

Tavsiye

Alternatif olarak, bu Hızlı Başlangıcı GitHub Codespaces'ta açın ve tüm geliştirici önkoşulları zaten yüklüdür. Kendi Azure aboneliğinizi getirmeniz yeterlidir. GitHub hesapları, hiçbir ücret ödemeden depolama ve çekirdek saat yetkilendirmesi içerir. Daha fazla bilgi için bkz . GitHub hesapları için dahil edilen depolama ve çekirdek saatler.

Veri API'sini oluşturucu CLI'yi yükleme

Microsoft.DataApiBuilder Paketi NuGet'ten .NET aracı olarak yükleyin.

1. En son sürümünü dotnet tool install bağımsız değişkeniyle yüklemek için Microsoft.DataApiBuilder öğesini --global kullanın.

   dotnet tool install --global Microsoft.DataApiBuilder
   

   Uyarı

   Paket zaten yüklüyse, yerine kullanarak dotnet tool updatepaketi güncelleştirin.

   dotnet tool update --global Microsoft.DataApiBuilder
   

2. dotnet tool list aracının, --global bağımsız değişkeniyle yüklü olduğunu doğrulayın.

   dotnet tool list --global
   

Yerel veritabanını yapılandırma

Yerel veritabanını yapılandırarak ve çalıştırarak başlayın. Ardından örnek verilerle yeni bir kapsayıcı oluşturabilirsiniz.

1. Docker Hub'dan kapsayıcı görüntüsünün postgres:16 en son kopyasını alın.

   docker pull postgres:16
   

2. Parolayı ayarlayıp 5432 numaralı bağlantı noktasını yayımlayarak docker kapsayıcısını başlatın. yerine özel bir parola yazın <your-password> .

   docker run \
       --publish 5432:5432 \
       --env "POSTGRES_PASSWORD=<your-password>" \
       --detach \
       postgres:16
   

3. Tercih ettiğiniz veri yönetimi ortamını kullanarak yerel veritabanınıza bağlanın. Örnekler şunlardır ancak bunlarla sınırlı değildir: pgAdmin ve Visual Studio Code için PostgreSQL uzantısı.

   Tavsiye

   Docker Linux kapsayıcı görüntüleriniz için varsayılan ağ kullanıyorsanız, bağlantı dizesi büyük olasılıkla olacaktır Host=localhost;Port=5432;User ID=postgres;Password=<your-password>;. yerine daha önce ayarladığınız parolayı yazın <your-password> .

4. Yeni bookshelf bir veritabanı oluşturun.

   DROP DATABASE IF EXISTS bookshelf;
   
   CREATE DATABASE bookshelf;
   

5. Yeni dbo.authors bir tablo oluşturun ve tabloyu temel verilerle doldurun.

   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');
   

Yapılandırma dosyaları oluşturma

DAB CLI kullanarak bir temel yapılandırma dosyası oluşturun. Ardından, geçerli kimlik bilgilerinizle bir geliştirme yapılandırma dosyası ekleyin.

1. kullanarak dab inittipik bir yapılandırma dosyası oluşturun. İlk bölümdeki veritabanı bağlantı dizenizle --connection-string bağımsız değişkenini ekleyin. yerine bu kılavuzun önceki bölümlerinde ayarladığınız parolayı yazın <your-password> . Ayrıca, değeri bağlantı dizesine ekleyin Database=bookshelf .

   dab init --database-type "postgresql" --host-mode "Development" --connection-string "Host=localhost;Port=5432;Database=bookshelf;User ID=postgres;Password=<your-password>;"
   

2. kullanarak bir dab add varlığı ekleyin.

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

API'yi yerel veritabanıyla test edin

Şimdi, yapılandırma dosyalarınızın geliştirme sırasında birleştirildiğini doğrulamak için Veri API'sini oluşturucu aracını başlatın.

1. Aracı çalıştırmak ve varlığınız için API uç noktaları oluşturmak için kullanın dab start .

   dab start
   

2. Aracın çıktısı, çalışan API'ye gitmek için kullanılacak adresi içermelidir.

         Successfully completed runtime initialization.
   info: Microsoft.Hosting.Lifetime[14]
         Now listening on: <http://localhost:5000>
   info: Microsoft.Hosting.Lifetime[0]
   

   Tavsiye

   Bu örnekte, uygulama localhost numaralı bağlantı noktasında çalışıyor. Çalışan uygulamanızın farklı bir adresi ve bağlantı noktası olabilir.

3. İlk olarak, /api/Author adresine bir GET isteği göndererek API'yi el ile deneyin.

   Tavsiye

   Bu örnekte URL olacaktır https://localhost:5000/api/Author. Web tarayıcınızı kullanarak bu URL'ye gidebilirsiniz.

4. Swagger belgeleri sayfasına /swagger adresinden gidin.

   Tavsiye

   Bu örnekte URL olacaktır https://localhost:5000/swagger. Yine web tarayıcınızı kullanarak bu URL'ye gidebilirsiniz.

Sonraki adım

REST uç noktalarını