Bagikan melalui

Mulai cepat: Menggunakan penyusun API Data dengan MySQL

Dalam Mulai Cepat ini, Anda membuat sekumpulan file konfigurasi penyusun API Data untuk menargetkan database MySQL lokal.

Prasyarat

Petunjuk / Saran

Atau, buka Mulai Cepat ini di GitHub Codespaces dengan semua prasyarat pengembang sudah diinstal. Cukup bawa langganan Azure Anda sendiri. Akun GitHub mencakup pemberian izin penyimpanan dan jam inti tanpa biaya. Untuk informasi selengkapnya, lihat penyimpanan dan jam inti yang disertakan untuk akun GitHub.

Buka di GitHub Codespaces

Menginstal pembangun API Data CLI

Instal paket Microsoft.DataApiBuilder dari NuGet sebagai alat .NET.

  1. Gunakan dotnet tool install untuk menginstal versi terbaru dari Microsoft.DataApiBuilder dengan argumen --global.

    dotnet tool install --global Microsoft.DataApiBuilder

    Nota

    Jika paket sudah diinstal, perbarui paket sebagai gantinya menggunakan dotnet tool update.

    dotnet tool update --global Microsoft.DataApiBuilder

  2. Verifikasi bahwa alat diinstal dengan dotnet tool list menggunakan argumen --global.

    dotnet tool list --global

Mengonfigurasi database lokal

Mulailah dengan mengonfigurasi dan menjalankan database lokal. Kemudian, Anda dapat menyemai kontainer baru dengan data sampel.

  1. Dapatkan salinan gambar kontainer terbaru dari Docker Hub.

    docker pull mysql:8

  2. Mulai kontainer docker dengan mengatur kata sandi dan menerbitkan port 3306. Ganti <your-password> dengan kata sandi kustom.

    docker run \
    --publish 3306:3306 \
    --env "MYSQL_ROOT_PASSWORD=<your-password>" \
    --detach \
    mysql:8

  3. Sambungkan ke database lokal Anda menggunakan lingkungan manajemen data pilihan Anda. Contohnya termasuk, tetapi tidak terbatas pada: MySQL Workbench dan shell MySQL untuk Visual Studio Code.

    Petunjuk / Saran

    Jika Anda menggunakan jaringan default untuk gambar kontainer Docker Linux Anda, string koneksi kemungkinan akan menjadi Server=localhost;Port=3306;Uid=root;Pwd=<your-password>;. Ganti <your-password> dengan kata sandi yang Anda tetapkan sebelumnya.

  4. Buat database baru bookshelf dan gunakan database untuk kueri Anda yang tersisa.

    CREATE DATABASE IF NOT EXISTS bookshelf;

USE bookshelf;

  5. Buat tabel baru dbo.authors dan masukkan tabel dengan data dasar.

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

Membuat file konfigurasi

Buat file konfigurasi garis besar menggunakan DAB CLI. Kemudian, tambahkan file konfigurasi pengembangan dengan kredensial Anda saat ini.

  1. Buat file konfigurasi umum menggunakan dab init. Tambahkan argumen --connection-string dengan menggunakan string koneksi database dari bagian pertama Anda. Ganti <your-password> dengan kata sandi yang Anda tetapkan sebelumnya dalam panduan ini. Selain itu, tambahkan nilai Database=bookshelf ke string koneksi.

    dab init --database-type "mysql" --host-mode "Development" --connection-string "Server=localhost;Port=3306;Database=bookshelf;Uid=root;Pwd=<your-password>;"

  2. Tambahkan entitas Penulis menggunakan dab add.

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

  3. Amati file konfigurasi dab-config.json Anda saat ini. File harus menyertakan implementasi garis besar API Anda dengan satu entitas, titik akhir REST API, dan titik akhir GraphQL.

Menguji API dengan database lokal

Sekarang, jalankan alat pembuat API Data untuk memastikan bahwa file konfigurasi Anda digabungkan dalam proses pengembangan.

  1. Gunakan dab start untuk menjalankan alat dan membuat titik akhir API untuk entitas Anda.

    dab start

  2. Output alat harus menyertakan alamat yang akan digunakan untuk menavigasi ke API yang sedang berjalan.

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

    Petunjuk / Saran

    Dalam contoh ini, aplikasi berjalan pada localhost port 5000. Aplikasi anda yang sedang berjalan mungkin memiliki alamat dan port yang berbeda.

  3. Pertama, coba API secara manual dengan mengeluarkan permintaan GET ke /api/Author.

    Petunjuk / Saran

    Dalam contoh ini, URL akan menjadi https://localhost:5000/api/Author. Anda dapat menavigasi ke URL ini menggunakan browser web Anda.

  4. Selanjutnya, navigasikan ke halaman dokumentasi Swagger di /swagger.

    Petunjuk / Saran

    Dalam contoh ini, URL akan menjadi https://localhost:5000/swagger. Sekali lagi, Anda dapat menavigasi ke URL ini menggunakan browser web Anda.

Langkah selanjutnya

titik akhir REST

  • Last updated on