Aracılığıyla paylaş


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

Bu Hızlı Başlangıçta, yerel bir SQL veritabanını hedeflemek için bir dizi Data API builder yapılandırma dosyası oluşturacaksınız.

Önkoşullar

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.

GitHub Codespaces'ta aç

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

İlgili kimlik bilgilerini ayarlamak için yerel veritabanını yapılandırıp çalıştırarak başlayın. Ardından örnek verilerle veritabanının tohumunu oluşturabilirsiniz.

  1. Docker Hub'dan kapsayıcı görüntüsünün mcr.microsoft.com/mssql/server:2022-latest en son kopyasını alın.

    docker pull mcr.microsoft.com/mssql/server:2022-latest
    
  2. Parolayı ayarlayarak, son kullanıcı lisans sözleşmesini (EULA) kabul ederek ve 1433 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 \
        --env "ACCEPT_EULA=Y" \
        --env "MSSQL_SA_PASSWORD=<your-password>" \
        --publish 1433:1433 \
        --detach \
        mcr.microsoft.com/mssql/server:2022-latest
    
  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: SQL Server Management Studio ve Visual Studio Code için SQL Server 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 Server=localhost,1433;User Id=sa;Password=<your-password>;TrustServerCertificate=True;Encrypt=True;. yerine daha önce ayarladığınız parolayı yazın <your-password> .

  4. Yeni bookshelf bir veritabanı oluşturun ve kalan sorgularınız için veritabanını kullanın.

    DROP DATABASE IF EXISTS bookshelf;
    GO
    
    CREATE DATABASE bookshelf;
    GO
    
    USE bookshelf;
    GO
    
  5. Yeni dbo.authors bir tablo oluşturun ve tabloyu temel verilerle doldurun.

    DROP TABLE IF EXISTS dbo.authors;
    GO
    
    CREATE TABLE dbo.authors
    (
        id int not null primary key,
        first_name nvarchar(100) not null,
        middle_name nvarchar(100) null,
        last_name nvarchar(100) not null
    )
    GO
    
    INSERT INTO dbo.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')
    GO
    

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 "mssql" --host-mode "Development" --connection-string "Server=localhost,1433;User Id=sa;Database=bookshelf;Password=<your-password>;TrustServerCertificate=True;Encrypt=True;"
    
  2. kullanarak bir dab add varlığı ekleyin.

    dab add Author --source "dbo.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