Mengimpor API OData

  • Artikel

BERLAKU UNTUK: Semua tingkatAN API Management

Artikel ini memperlihatkan cara mengimpor layanan yang mematuhi OData sebagai API di API Management.

Dalam artikel ini, Anda akan mempelajari cara:

  • Mengimpor deskripsi metadata OData menggunakan portal Azure
  • Mengelola skema OData di portal
  • Mengamankan API OData

Catatan

Mengimpor layanan OData sebagai API dari deskripsi metadatanya dalam pratinjau.

Prasyarat

  • Sebuah instans API Management. Jika Anda belum memilikinya, selesaikan mulai cepat berikut: Membuat instans Azure API Management.

  • Layanan yang diekspos sebagai OData v2 atau v4.

Membuka instans API Management Anda

  1. Di portal Microsoft Azure, cari dan pilih layanan API Management.

    Pilih layanan API Management

  2. Di halaman layanan API Management, pilih instans API Management Anda.

    Pilih instans API Management Anda

Mengimpor metadata OData

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

  2. Di bawah Buat dari definisi, pilih OData.

    Cuplikan layar pembuatan API dari deskripsi OData di portal.

  3. Masukkan pengaturan API. Anda dapat memperbarui pengaturan nanti dengan masuk ke tab Pengaturan API.

    1. Dalam spesifikasi OData, masukkan URL untuk titik akhir metadata OData, biasanya URL ke akar layanan, ditambahkan dengan /$metadata. Atau, pilih file XML OData lokal untuk diimpor.

    2. Masukkan pengaturan yang tersisa untuk mengonfigurasi API Anda. Pengaturan ini dijelaskan dalam tutorial Impor dan terbitkan API pertama Anda.

  4. Pilih Buat.

    API ditambahkan ke daftar API . Kumpulan entitas dan fungsi yang diekspos dalam deskripsi metadata OData muncul di tab Kumpulan entitas dan fungsi API.

    Cuplikan layar set dan fungsi entitas OData di portal.

Memperbarui skema OData

Anda dapat mengakses editor di portal untuk melihat skema OData API Anda. Jika API berubah, Anda juga dapat memperbarui skema di API Management dari file atau titik akhir layanan OData.

  1. Di portal, navigasikan ke instans API Management Anda.

  2. Di menu sebelah kiri, pilih API> API OData Anda.

  3. Pada tab Kumpulan entitas dan fungsi , pilih menu konteks (...) di samping kumpulan entitas atau fungsi, dan pilih Edit.

    Cuplikan layar menu konteks untuk entitas OData yang diatur di portal.

  4. Tinjau skema. Jika Anda ingin memperbaruinya, pilih Perbarui dari file atau Perbarui skema dari titik akhir.

    Cuplikan layar editor skema untuk API OData di portal.

Menguji API OData Anda

  1. Di menu sebelah kiri, pilih API> API OData Anda.

  2. Pada tab Kumpulan entitas dan fungsi , pilih menu konteks (...) di samping set atau fungsi entitas, dan pilih Uji.

    Cuplikan layar opsi Uji pada menu konteks untuk entitas OData yang diatur di portal.

  3. Di konsol pengujian, masukkan parameter templat, parameter kueri, dan header untuk pengujian Anda, dan pilih Uji. Pelajari selengkapnya tentang menguji API di portal.

Mengamankan API OData Anda

Amankan API OData Anda dengan menerapkan kebijakan autentikasi dan otorisasi yang ada dan kebijakan validasi OData untuk melindungi dari serangan melalui permintaan API OData.

Tip

Di portal, konfigurasikan kebijakan untuk API OData Anda pada tab kebijakan API.

Menambahkan API lainnya

Anda dapat membuat API dari API yang diekspos oleh berbagai layanan, termasuk:

  • Spesifikasi OpenAPI
  • API SOAP
  • A GraphQL API
  • Aplikasi Web yang dihosting di Azure App Service
  • Azure Function App
  • Azure Logic Apps
  • Azure Service Fabric

Tambahkan API yang berbeda ke API yang ada menggunakan langkah-langkah berikut.

Catatan

Saat mengimpor API lain, operasi ditambahkan ke API Anda saat ini.

  1. Buka instans API Management Azure Anda di portal Microsoft Azure.

    Membuka instans Mgmt API Azure

  2. Pilih API pada halaman Ringkasan atau dari menu di sebelah kiri.

    Pilih API

  3. Klik ... di samping API tempat Anda ingin menambahkan API lain.

  4. Pilih Impor dari menu turun.

    Pilih impor

  5. Pilih layanan untuk mengimpor API.

    Pilih layanan