Bagikan melalui

Mengimpor API OData

BERLAKU UNTUK: Semua tingkat 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

Prasyarat

Masuk ke instans API Management Anda

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

    Cuplikan layar yang memperlihatkan layanan API Management di hasil pencarian.

  2. Pada halaman layanan API Management , pilih instans API Management Anda:

    Cuplikan layar yang menampilkan instans API Management di halaman layanan API Management.

Mengimpor metadata OData

  1. Di menu sebelah kiri, pilih API>, lalu pilih + 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. Nilai ini biasanya adalah URL ke induk layanan, ditambahkan dengan /$metadata. Atau, pilih file XML OData lokal untuk diimpor.

    2. Masukkan pengaturan tambahan 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 yang memperlihatkan set dan fungsi entitas OData.

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, lalu pilih API OData Anda.

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

    Cuplikan layar yang memperlihatkan lokasi perintah Edit.

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

    Cuplikan layar editor skema untuk API OData.

Menguji API OData Anda

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

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

    Cuplikan layar yang memperlihatkan perintah Uji.

  3. Di konsol pengujian, masukkan parameter templat, parameter kueri, dan header untuk pengujian Anda, lalu pilih Uji. Untuk informasi selengkapnya tentang menguji API di portal, lihat Menguji API baru 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.

Petunjuk

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

Menambahkan API lainnya

Anda dapat menyusun API dari API yang diekspos oleh layanan yang berbeda, termasuk:

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

Catatan

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

Untuk menambahkan API ke API yang ada:

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

    Cuplikan layar yang memperlihatkan halaman layanan API Management.

  2. Pilih API di halaman Gambaran Umum atau pilih API >API di menu di sebelah kiri.

    Cuplikan layar yang memperlihatkan pilihan API di halaman Gambaran Umum.

  3. Pilih elipsis (...) di samping API yang ingin Anda tambahkan API lain.

  4. Pilih Impor dari menu drop-down:

    Cuplikan layar yang memperlihatkan perintah Impor.

  5. Pilih layanan untuk mengimpor API.

Konten terkait

  • Last updated on