Aracılığıyla paylaş


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

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

Önkoşullar

İpucu

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'te aç

Veri API'sinin oluşturucu CLI'sını yükleme

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

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

    dotnet tool install --global Microsoft.DataApiBuilder
    

    Not

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

    dotnet tool update --global Microsoft.DataApiBuilder
    
  2. Aracının ile birlikte bağımsız değişkenini --global kullanarak yüklendiğini dotnet tool list doğrulayın.

    dotnet tool list --global
    

Yerel veritabanını yapılandırma

Yerel veritabanını yapılandırıp çalıştırarak başlayın. Ardından örnek verileri içeren yeni bir kapsayıcıyı dağıtabilirsiniz.

  1. kapsayıcı görüntüsünün mysql:8 en son kopyasını Docker Hub alın.

    docker pull mysql:8
    
  2. Parolayı ayarlayıp 3306 numaralı bağlantı noktasını yayımlayarak docker kapsayıcısını başlatın. değerini özel bir parolayla değiştirin <your-password> .

    docker run \
        --publish 3306:3306 \
        --env "MYSQL_ROOT_PASSWORD=<your-password>" \
        --detach \
        mysql:8
    
  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: MySQL Workbench, Azure Data Studio ve Visual Studio Code için MySQL kabuğu.

    İpucu

    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ırServer=localhost;Port=3306;Uid=root;Pwd=<your-password>;. değerini daha önce ayarladığınız parolayla değiştirin <your-password> .

  4. Yeni bookshelf bir veritabanı İçerik Oluşturucu ve kalan sorgularınız için veritabanını kullanın.

    CREATE DATABASE IF NOT EXISTS bookshelf;
    
    USE bookshelf;
    
  5. Yeni dbo.authors bir tablo İçerik Oluşturucu ve temel verilerle tabloyu dağıtın.

    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ını İçerik Oluşturucu

DAB CLI kullanarak bir temel yapılandırma dosyası İçerik Oluşturucu. Ardından, geçerli kimlik bilgilerinizle bir geliştirme yapılandırma dosyası ekleyin.

  1. kullanarak dab inittipik bir yapılandırma dosyası İçerik Oluşturucu. bağımsız değişkenini ilk bölümden --connection-string veritabanı bağlantı dizesi ekleyin. değerini bu kılavuzun önceki bölümlerinde ayarladığınız parolayla değiştirin <your-password> . Ayrıca değeri bağlantı dizesi ekleyinDatabase=bookshelf.

    dab init --database-type "mysql" --host-mode "Development" --connection-string "Server=localhost;Port=3306;Database=bookshelf;Uid=root;Pwd=<your-password>;"
    
  2. kullanarak dab addbir Author varlığı ekleyin.

    dab add Author --source "authors" --permissions "anonymous:*"
    
  3. Geçerli dab-config.json yapılandırma dosyanızı gözlemleyin. Dosya tek bir varlık, REST API uç noktası ve GraphQL uç noktası ile API'nizin temel uygulamasını içermelidir.

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]
    

    İpucu

    Bu örnekte uygulama 5000 numaralı bağlantı noktasında çalıştırılırlocalhost. Çalışan uygulamanızın farklı bir adresi ve bağlantı noktası olabilir.

  3. İlk olarak, öğesine bir GET isteği vererek API'yi /api/Authorel ile deneyin.

    İpucu

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

  4. Ardından konumundaki Swagger belgeleri sayfasına /swaggergidin.

    İpucu

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

Sonraki adım