Bagikan melalui


Membuat API untuk GraphQL di Fabric dan menambahkan data

Mulai menggunakan Fabric API untuk GraphQL dengan membuat API, lalu menautkan sumber data untuk mengekspos data yang Anda pilih melalui API. Fabric membangun skema GraphQL secara otomatis berdasarkan data Anda, dan aplikasi siap untuk terhubung dalam hitungan menit.

Siapa yang harus membuat API GraphQL

Membuat API GraphQL di Fabric dirancang untuk:

  • Insinyur data mengekspos data lakehouse dan warehouse Fabric melalui API modern untuk konsumsi aplikasi
  • Kontributor ruang kerja Fabric yang ingin membuat API akses data dengan cepat tanpa menulis kode backend
  • Pengembang BI membangun aplikasi analitik kustom yang membutuhkan akses terprogram ke data Fabric
  • Pengembang integrasi yang membuat lapisan akses data untuk aplikasi kustom dan alur kerja otomatis
  • Tim pengembangan yang lebih memilih pendekatan GraphQL yang fleksibel dan aman jenis daripada koneksi database langsung

Gunakan panduan ini saat Anda perlu membuat API GraphQL baru yang mengekspos data Fabric lakehouse, gudang, atau database Anda ke aplikasi.

Prasyarat

Untuk membuat API untuk GraphQL, Anda memerlukan:

Izin Anda:

  • Jadilah anggota ruang kerja Fabric tempat Anda ingin membuat API
  • Memiliki setidaknya peran Kontributor di ruang kerja tersebut (atau lebih tinggi: Admin, Anggota)

Penyiapan organisasi:

  • Admin Fabric atau Administrator kapasitas harus mengaktifkan pengaturan penyewa "Pengguna dapat membuat item Fabric"

    Cuplikan layar pengaturan tenant dan tempat mengaktifkan opsi Pengguna dapat membuat item Fabric.

  • Ruang kerja harus didukung oleh kapasitas Fabric (kapasitas Premium, Uji Coba, atau kapasitas Fabric)

Akses sumber data (untuk langkah selanjutnya):

  • Izin baca pada sumber data yang Anda rencanakan untuk diekspos melalui API GraphQL
  • Izin dapat diberikan melalui keanggotaan ruang kerja atau izin sumber data langsung
  • Dalam panduan ini, kami menggunakan titik akhir analitik AdventureWorks SQL yang ditautkan ke database cermin sebagai contoh sumber data. Untuk mendapatkan data sampel AdventureWorks, lihat Memuat data sampel AdventureWorks di database SQL Anda.

Membuat API untuk GraphQL

Untuk membuat API untuk GraphQL:

  1. Buka portal Fabric di https://fabric.microsoft.com dan masuk dengan akun organisasi Anda.

  2. Pilih ruang kerja tempat Anda ingin membuat API lalu pilih Item baru. Di panel yang terbuka, di bawah Kembangkan data, pilih API untuk GraphQL.

    Cuplikan layar toolbar ruang kerja, memperlihatkan tempat untuk memilih opsi Baru.

  3. Masukkan Nama untuk item API baru Anda untuk GraphQL dan pilih Buat.

Anda sekarang memiliki titik akhir API GraphQL aktif di Fabric. Pada titik ini, Anda dapat menyalin URL titik akhir dari portal Fabric, pilih Buat kode untuk mendapatkan sampel kode, dan API siap menerima permintaan. Di bagian berikutnya, kami akan menghubungkan sumber data untuk membangun skema Anda, tetapi titik akhir itu sendiri sudah berfungsi.

Menyambungkan ke sumber data dan membangun skema Anda

Pada titik ini, titik akhir API siap tetapi belum mengekspos data apa pun. API untuk GraphQL didefinisikan dalam skema yang diatur dalam hal jenis dan bidang, dalam sistem yang sangat diketik. Fabric secara otomatis menghasilkan skema GraphQL yang diperlukan berdasarkan data yang Anda pilih untuk diekspos ke klien GraphQL.

Untuk menyambungkan sumber data dan membangun skema Anda:

  1. Pastikan Anda memilih item GraphQL API baru di ruang kerja Anda.

  2. Di bawah Tambahkan data ke API untuk GraphQL pilih petak Pilih sumber data .

    Cuplikan layar petak Pilih sumber data.

  3. Selanjutnya pilih opsi konektivitas untuk API Anda:

    Cuplikan layar jendela opsi Pilih konektivitas.

    Di sini Anda dapat menentukan bagaimana klien API dapat mengakses API untuk menjalankan permintaan GraphQL berdasarkan dua opsi yang berbeda:

    • Akses menyeluruh (SSO): Anda dapat menggunakan kredensial klien untuk menyambungkan ke sumber data. Pengguna API yang diautentikasi harus memiliki akses ke tabel yang mendasar di sumber data.

      Misalnya, jika Anda mengekspos data Lakehouse ke klien API Anda, pengguna yang diautentikasi harus memiliki akses ke API dan Lakehouse. Lebih khusus lagi, izin Jalankan ke API GraphQL ( opsiJalankan Kueri dan Mutasi saat menambahkan izin akses langsung) dan izin baca atau tulis yang diperlukan dalam sumber data pilihan. Atau, pengguna dapat ditambahkan sebagai anggota ruang kerja dengan peran kontributor di mana API dan item sumber data berada, yang menyediakan akses yang diperlukan ke kedua item dari satu lokasi. Untuk informasi selengkapnya, lihat Memberi pengguna akses ke ruang kerja.

    • Kredensial tersimpan: Anda bisa menggunakan kredensial tersimpan untuk menyambungkan ke sumber data. Pengguna API yang diautentikasi tidak memerlukan akses langsung ke data. Kredensial yang disimpan dibagikan untuk mengakses data antara API dan tabel yang mendasar di sumber data.

      Misalnya, jika Anda mengekspos data Lakehouse ke klien API Anda, pengguna yang diautentikasi hanya perlu memiliki akses langsung ke API (opsi Jalankan Kueri dan Mutasi saat menambahkan izin akses langsung) dan bukan Lakehouse. Kredensial yang disimpan digunakan untuk menghubungkan API ke sumber data dan dibagikan oleh semua pengguna API yang diautentikasi. Opsi ini diperlukan jika Anda mengekspos sumber data Azure seperti database Azure SQL melalui GraphQL.

    Setelah dipilih, opsi ini diberlakukan untuk semua sumber data yang kemudian ditambahkan ke API. Tidak dimungkinkan untuk mencampur akses menyeluruh dan kredensial yang disimpan di API yang sama. Anda dapat menggunakan Nama Prinsipal Pengguna (UPN) atau Nama Prinsipal Layanan (SPN) untuk menyambungkan ke API Anda, menggunakan SSO atau kredensial yang disimpan tergantung pada persyaratan keamanan Anda.

    Untuk perincian terperinci persyaratan izin untuk skenario autentikasi yang berbeda, lihat Ringkasan autentikasi dan izin.

    Catatan

    API untuk GraphQL mengharuskan aplikasi klien menggunakan ID Microsoft Entra untuk autentikasi. Aplikasi klien Anda harus didaftarkan dan dikonfigurasi secara memadai untuk menjalankan panggilan API terhadap Fabric. Aplikasi yang terdaftar di MICROSOFT Entra ID memerlukan izin GraphQLApi.Execute.All API untuk layanan Power BI. Anda dapat menemukan tutorial end-to-end dengan instruksi dan kode sampel untuk perwakilan pengguna dan perwakilan layanan di Connect Applications.

  4. Dari katalog OneLake, pilih sumber data yang ingin Anda sambungkan. Pilih Filter untuk melihat hanya jenis sumber data Fabric tertentu, atau cari menurut kata kunci tertentu. Saat Anda siap, pilih Sambungkan.

    Cuplikan layar hub data OneLake, memperlihatkan opsi sumber data yang tersedia untuk ruang kerja.

    Dalam contoh ini, kami memilih titik akhir analitik SQL yang ditautkan ke database cermin yang berisi data sampel AdventureWorks.

  5. Jika Anda memilih Kredensial tersimpan sebelumnya, dan jika tidak ada kredensial tersimpan untuk API GraphQL Anda, Anda akan diminta untuk membuat kredensial baru yang disimpan.

  6. Halaman Pilih data muncul, tempat Anda dapat memilih objek mana yang ingin Anda ekspos dalam skema GraphQL Anda.

  7. Pilih kotak centang di samping tabel, tampilan, atau prosedur tersimpan individual yang ingin Anda ekspos di API. Untuk memilih semua objek dalam folder, pilih kotak centang dengan nama sumber data di bagian atas.

    Cuplikan layar penjelajah data dengan folder dipilih, yang secara otomatis memilih semua item di dalam folder tersebut.

  8. Pilih Muat untuk memulai proses pembuatan skema GraphQL.

  9. Skema dibuat dan Anda dapat mulai membuat prototipe kueri GraphQL (baca, daftar) atau mutasi (buat, perbarui, hapus) untuk berinteraksi dengan data Anda.

    Cuplikan layar penjelajah Skema.

    Tip

    Masukkan Ctrl/Cmd + bilah spasi untuk mendapatkan saran saat menulis kueri Anda di editor.

    Untuk informasi selengkapnya tentang menggunakan editor API, lihat Fabric API untuk editor GraphQL.

Ringkasan

Itu saja! Anda berhasil membuat API GraphQL di Fabric, menghubungkan sumber data Anda, dan menghasilkan skema. API Anda sekarang siap untuk menerima koneksi dan permintaan dari aplikasi klien. Anda dapat menggunakan editor API untuk menguji dan membuat prototipe kueri GraphQL, dan menggunakan penjelajah Skema untuk memverifikasi jenis data dan bidang yang diekspos di API.