Bagikan melalui

Fabric API untuk introspeksi GraphQL dan ekspor skema

Fabric API untuk GraphQL menyediakan dua mekanisme untuk mengambil informasi tentang skema Anda.

  1. Introspeksi: Ini adalah bagian dari standar GraphQL dan memungkinkan pengajuan kueri skema secara terprogram. Kueri introspeksi memungkinkan Anda mempelajari skema GraphQL API, dan kueri tersebut juga membantu mendukung alat pengembangan GraphQL.

  2. Ekspor skema: Ini memungkinkan Anda untuk mendapatkan file SDL (Bahasa Definisi Skema GraphQL) yang berisi skema lengkap Anda untuk penggunaan eksternal.

Introspeksi

Secara default, introspeksi dinonaktifkan pada API Anda untuk item GraphQL. Pengaturan ini hanya dapat diubah oleh Admin Workspace. Semua pengguna lain akan melihat penggeser yang dinonaktifkan. Untuk mengaktifkannya, klik ikon roda gigi Pengaturan API di menu atas dan pilih Introspeksi dari pengaturan yang tersedia. Anda akan melihat tombol untuk mengaktifkan atau menonaktifkan introspeksi:

Cuplikan layar yang memperlihatkan bilah portal yang memperlihatkan tombol gigi pengaturan.

Cuplikan layar yang memperlihatkan penggerak pengaturan introspeksi.

Jika Anda mengaktifkan introspeksi, dialog konfirmasi berikut ditampilkan:

Cuplikan layar yang memperlihatkan dialog konfirmasi aktifkan introspeksi.

Pilih konfirmasi untuk mengaktifkan introspeksi atau batal untuk membiarkannya dinonaktifkan.

Contoh kueri introspeksi

Berikut adalah contoh cepat kueri introspeksi untuk mengambil jenis yang tersedia dari skema:

query {
    __schema {
        types{
            name
        }
    }
}

Cuplikan layar yang memperlihatkan contoh kueri introspeksi.

Informasi yang diambil oleh kueri introspeksi terlalu rinci. Anda bisa menggunakan filter kueri untuk mempersempit cakupan kueri.

Untuk mempelajari lebih lanjut tentang introspeksi, lihat dokumentasi resmi GraphQL Foundation tentang introspeksi.

Mengekspor skema

Cara lain untuk mengambil informasi skema adalah menggunakan ekspor skema GraphQL. Ini berfungsi langsung dari portal Fabric. Buka API Anda untuk GraphQL dan pilih Ekspor skema. Dan browser Anda akan mengunduh file SDL (Bahasa Definisi Skema) dengan skema lengkap. Anda kemudian dapat menggunakan file SDL ini di alat atau layanan pengembangan apa pun seperti, misalnya, terintegrasi dengan Azure API Management.

Cuplikan layar yang memperlihatkan tombol skema ekspor.

Konten terkait