Mengimpor API GraphQL

BERLAKU UNTUK: Semua tingkatAN API Management

Di API Management, Anda dapat menambahkan API GraphQL di salah satu dari dua model: pass-through ke titik akhir GraphQL yang ada, atau mengimpor skema GraphQL dan membuat API GraphQL sintetis dengan pemecah bidang kustom. Untuk informasi selengkapnya, lihat gambaran umum GraphQL.

Dalam artikel ini, Anda akan:

• Tambahkan API GraphQL pass-through ke instans API Management Anda.
• Menguji API GraphQL.

Jika Anda ingin mengimpor skema GraphQL dan menyiapkan penyelesai bidang menggunakan titik akhir REST atau SOAP API, lihat Mengimpor skema GraphQL dan menyiapkan penyelesai bidang.

Prasyarat

• Instans API Management yang ada. Buat jika Anda belum melakukannya.

• Sebuah API GraphQL.

• Azure CLI

  • Gunakan lingkungan Bash di Azure Cloud Shell. Untuk informasi selengkapnya, lihat Mulai Cepat untuk Bash di Azure Cloud Shell.

    

  • Jika Anda lebih suka menjalankan perintah referensi CLI secara lokal, instal Azure CLI. Jika Anda menjalankan Windows atau macOS, pertimbangkan untuk menjalankan Azure CLI dalam kontainer Docker. Untuk informasi lebih lanjut, lihat Cara menjalankan Azure CLI di kontainer Docker.

    • Jika Anda menggunakan instalasi lokal, masuk ke Azure CLI dengan menggunakan perintah login az. Untuk menyelesaikan proses autentikasi, ikuti langkah-langkah yang ditampilkan di terminal Anda. Untuk opsi masuk lainnya, lihat Masuk dengan Azure CLI.

    • Saat Anda diminta, instal ekstensi Azure CLI pada penggunaan pertama. Untuk informasi selengkapnya tentang ekstensi, lihat Menggunakan ekstensi dengan Azure CLI.

    • Jalankan versi az untuk menemukan versi dan pustaka dependen yang diinstal. Untuk meningkatkan ke versi terbaru, jalankan peningkatan az.

• Azure PowerShell

  • Jika Anda memilih untuk menggunakan Azure PowerShell secara lokal:
    • Instal versi terbaru modul Az PowerShell.
    • Sambungkan ke akun Azure Anda menggunakan cmdlet Connect-AzAccount.
  • Jika Anda memilih untuk menggunakan Azure Cloud Shell:
    • Lihat Gambaran Umum Azure Cloud Shell untuk informasi selengkapnya.

Menambahkan API GraphQL

Portal

1. Di Portal Microsoft Azure, navigasikan ke instans API Management Anda.

2. Di menu sebelah kiri, pilih API>+ Tambahkan API.

3. Pada Tentukan API baru, pilih ikon GraphQL.

   

4. Dalam kotak dialog, pilih Penuh dan lengkapi bidang formulir yang diperlukan.

   

   Bidang	Deskripsi
   Nama tampilan	Nama yang akan ditampilkan untuk API WebSocket Anda.
   Nama	Nama asli API GraphQL. Otomatis terisi saat Anda mengetik nama tampilan.
   Jenis GraphQL	Pilih Pass-through GraphQL untuk mengimpor dari titik akhir GraphQL API yang ada.
   Titik akhir API GraphQL	URL dasar dengan nama titik akhir API GraphQL Anda. Misalnya: https://example.com/your-GraphQL-name. Anda juga dapat menggunakan titik akhir GraphQL "swapi" umum seperti https://swapi-graphql.azure-api.net/graphql demo.
   Mengunggah skema	Secara opsional pilih untuk menelusuri dan mengunggah file skema Anda untuk menggantikan skema yang diambil dari titik akhir GraphQL (jika tersedia).
   Keterangan	Menambahkan deskripsi API Anda.
   Skema URL	Buat pilihan berdasarkan titik akhir GraphQL Anda. Pilih salah satu opsi yang menyertakan skema WebSocket (WS atau WSS) jika API GraphQL Anda menyertakan jenis langganan. Pilihan default: HTTP(S).
   Akhiran URL API	Tambahkan sufiks URL untuk mengidentifikasi API spesifik ini dalam instans API Management ini. Akhiran harus unik dalam instans API Management ini.
   URL Dasar	Bidang yang tidak dapat diedit dan menampilkan URL basis API Anda
   Tag	Mengaitkan API GraphQL Anda dengan tag baru atau yang sudah ada.
   Produk	Mengaitkan API WebSocket Anda dengan produk untuk memublikasikannya.
   Versi API ini?	Pilih untuk menerapkan skema penerapan versi ke API GraphQL Anda.

5. Pilih Buat.

6. Setelah API dibuat, telusuri atau ubah skema pada tab Desain .

Azure CLI

Contoh berikut menggunakan perintah az apim api import untuk mengimpor API passthrough GraphQL dari URL yang ditentukan ke instans API Management bernama apim-hello-world.

# API Management service-specific details
APIMServiceName="apim-hello-world"
ResourceGroupName="myResourceGroup"

# API-specific details
APIId="my-graphql-api"
APIPath="myapi"
DisplayName="MyGraphQLAPI"
SpecificationFormat="GraphQL"
SpecificationURL="<GraphQL backend endpoint>"

# Import API
az apim api import --path $APIPath --resource-group $ResourceGroupName \
    --service-name $APIMServiceName --api-id $APIId \
    --display-name $DisplayName --specification-format $SpecificationFormat --specification-url $SpecificationURL

Setelah mengimpor API, jika diperlukan, Anda dapat memperbarui pengaturan dengan menggunakan perintah az apim api update .

PowerShell

Contoh berikut menggunakan cmdlet Import-AzApiManagementApi Azure PowerShell untuk mengimpor API passthrough GraphQL dari URL yang ditentukan ke instans API Management bernama apim-hello-world.

# API Management service-specific details
$apimServiceName = "apim-hello-world"
$resourceGroupName = "myResourceGroup"

# API-specific details
$apiId = "my-graphql-api"
$apiPath = "myapi"
$specificationFormat = "GraphQL"
$specificationUrl = "<GraphQL backend endpoint>"

# Get context of the API Management instance. 
$context = New-AzApiManagementContext -ResourceGroupName $resourceGroupName -ServiceName $apimServiceName

# Import API
Import-AzApiManagementApi -Context $context -ApiId $apiId -SpecificationFormat $specificationFormat -SpecificationUrl $specificationUrl -Path $apiPath

Setelah mengimpor API, jika diperlukan, Anda dapat memperbarui pengaturan dengan menggunakan cmdlet Set-AzApiManagementApi .

Menguji API GraphQL Anda

1. Navigasi ke instans API Management Anda.

2. Dari menu navigasi samping, di bagian API, pilih API.

3. Di bawah Semua API, pilih API GraphQL Anda.

4. Pilih tab Uji untuk mengakses konsol Uji.

5. Di bawah Header:

   1. Pilih header dari menu drop-down Nama.
   2. Masukkan nilai ke bidang Nilai.
   3. Tambahkan lebih banyak lagi header dengan memilih + Tambahkan header.
   4. Hapus header menggunakan ikon keranjang sampah.

6. Jika Anda telah menambahkan produk ke API GraphQL Anda, terapkan lingkup produk di bawah Terapkan lingkup produk.

7. Di bawah Editor Kueri, pilih:

   1. Setidaknya satu bidang atau subbidang dari daftar di menu samping. Bidang dan subbidang yang Anda pilih akan muncul di editor kueri.

   2. Mulailah mengetik di editor kueri untuk menulis kueri.

      

8. Di bawah Variabel kueri, tambahkan variabel untuk menggunakan kembali kueri atau mutasi yang sama dan melewatkan nilai yang berbeda.

9. Pilih Kirim.

10. Menampilkan Respons.

    

11. Ulangi langkah-langkah sebelumnya untuk menguji payload yang berbeda.

12. Ketika pengujian selesai, keluar dari konsol pengujian.

Menguji langganan

Jika GraphQL API mendukung langganan, Anda dapat mengujinya di konsol pengujian.

1. Pastikan API Anda mengizinkan skema URL WebSocket (WS atau WSS) yang sesuai untuk API Anda. Anda dapat mengaktifkan pengaturan ini pada tab Pengaturan .

2. Siapkan kueri langganan di editor kueri, lalu pilih Sambungkan untuk membuat koneksi WebSocket ke layanan backend.

   

3. Tinjau detail koneksi di panel Langganan.

   

4. Peristiwa berlangganan muncul di panel Langganan . Koneksi WebSocket dipertahankan hingga Anda memutuskan sambungannya atau Anda tersambung ke langganan WebSocket yang baru.

   

Mengamankan API GraphQL Anda

Amankan API GraphQL Anda dengan menerapkan kebijakan autentikasi dan otorisasi yang ada dan kebijakan validasi GraphQL untuk melindungi dari serangan khusus GraphQL.

Topik terkait

• Batasan impor API
• Mengimpor spesifikasi OpenAPI
• Mengimpor API SOAP
• Mengimpor SOAP API dan mengonversi ke REST
• Impor API App Service
• Impor API Aplikasi Kontainer
• Mengimpor API WebSocket
• Mengimpor API GraphQL
• Mengimpor skema GraphQL dan menyiapkan penyelesai bidang
• Impor Aplikasi Fungsi Azure
• Impor Azure Logic App
• Impor layanan Service Fabric
• Mengimpor API Azure OpenAI
• Mengimpor API OData
• Mengimpor metadata SAP OData
• Mengimpor API gRPC
• Edit API

Langkah berikutnya

Mengubah dan memproteksi API yang diterbitkan