Impor dan terbitkan API

  • 5 menit

Untuk membuat API tersedia melalui gateway API, Anda perlu mengimpor dan menerbitkan API.

Dalam contoh perusahaan sepatu, NorthWind Shoes ingin memungkinkan mitra tertentu dapat mengkueri inventaris dan tingkat stok.

Di sini, Anda mempelajari cara mengimpor API ke Azure API Management, dan cara membuat API tersedia untuk klien.

API

API adalah cara standar bagi organisasi untuk mengekspose data tertentu kepada calon pengembang atau mitra. Misalnya, dalam latihan sebelumnya Anda membuat API untuk berbagi informasi tentang produk dan inventaris.

Membuat API tersedia dimulai dengan mengimpor API ke API Management. Anda kemudian dapat:

  • Menggunakan alat visualisasi di gateway API untuk menguji API Anda.
  • Mengelola akses ke API Anda menggunakan kebijakan.

Kerangka kerja API

Ada berbagai kerangka kerja dan standar API. API Management memberi Anda beberapa opsi untuk mengimpor API.

Jenis Detail
HTTP Anda dapat mengimpor API HTTP dengan definisi API kosong. Anda kemudian secara manual menentukan semua parameter yang diperlukan.
WebSocket Siapkan pass-through ke layanan WebSocket backend.
GraphQL Siapkan pass-through ke layanan GraphQL backend, atau impor skema GraphQL dan buat API GraphQL sintetis dengan pemecah bidang kustom.
OpenAPI OpenAPI adalah spesifikasi yang mendokuensikan semua titik akhir dan operasi untuk API RESTful, dan semua parameter input dan output. OpenAPI awalnya disebut Swagger.
WADL Web Application Description Language adalah deskripsi XML dari layanan web berbasis HTTP. Ini adalah format yang lebih sederhana dan lebih ringan daripada WSDL.
WSDL Web Application Description Language adalah deskripsi XML dari layanan jaringan apa pun, bukan hanya HTTP.

Anda juga dapat mengimpor API dari beberapa sumber daya Azure backend.

Jenis Detail
Aplikasi Logika Aplikasi logika digunakan untuk mengatur dan mengotomatiskan alur kerja dan integrasi dengan berbagai sumber data.
App Service API yang dihosting dalam layanan aplikasi di Azure.
Aplikasi Fungsi Kode tanpa server yang dapat dipanggil melalui pemicu.
Aplikasi Kontainer Kontainer tanpa server untuk layanan mikro.

Mengimpor API

Ada beberapa cara untuk mengimpor API ke Azure API Management.

Menggunakan portal Azure, Anda memilih API, lalu + Tambahkan API. Anda mulai dengan memilih jenis API yang ingin Anda impor.

Screenshot of Azure portal showing API Management service with the APIs section highlighted and selected.

Anda kemudian menyediakan tautan ke spesifikasi API Anda sebagai URL atau file, dan nama untuk API. Berikut ini contoh impor OpenAPI.

Screenshot of create from OpenAPI specification import settings with OpenAPI specification and display name fields highlighted.

Portal Azure bukanlah alat yang paling efisien untuk mengimpor dan mengonfigurasi sejumlah besar API. Saat meningkatkan manajemen API, Anda memerlukan alat lain, seperti Azure CLI, Azure Resource Manager, atau templat Bicep, atau Azure PowerShell. Misalnya, Anda dapat menggunakan cmdlet Azure PowerShell untuk menyebarkan gateway API, menentukan dan mengonfigurasi produk, mengimpor API, dan mengelola pengguna dan langganan.

Memvisualisasikan

Anda dapat menggunakan gateway API sebagai cara untuk memvisualisasikan bagaimana data diproses melalui API yang diimpor. Anda dapat berinteraksi dengan set data, dan meneruskan parameter melalui API Anda.

Jika Anda seorang administrator, Anda dapat memvisualisasikan API di portal Azure.

Screenshot of Azure portal API configuration showing a highlighted GET request test on an imported API.

Kebijakan

Kebijakan memberikan kemampuan yang kuat untuk mengubah perilaku API melalui konfigurasi. kebijakan ada sebagai kumpulan pernyataan yang dijalankan secara berurutan atas permintaan atau respons API.

Konfigurasi populer meliputi:

  • Konversi dari XML ke JSON
  • Pembatasan laju panggilan untuk membatasi jumlah panggilan masuk.
  • Mengatur header masuk dan keluar.

Anda menggunakan portal Azure untuk menerapkan kebijakan yang berbeda ke API. Kebijakan bisa ditampilkan dalam tab Desain.

Screenshot of Azure portal showing API configuration for all operations with base policies highlighted for inbound, outbound, and backend sections.

Anda juga dapat menggunakan tab Desain untuk menambahkan kebijakan baru.

Screenshot of Azure portal showing inbound policy options for API configuration.

Produk

Produk merupakan kumpulan API. Anda dapat menetapkan API ke lebih dari satu produk. Misalnya, Anda mungkin ingin satu produk, NorthWindShoesPartners, untuk mengekspos dua API untuk mitra Anda:

Produk NorthWindShoesPartners
API 1 Persediaan
API 2 Perencanaan

Untuk pemasok, Anda mungkin hanya ingin mengekspos satu API:

Produk NorthWindShoesSuppliers
API 1 Persediaan
API 2

Anda menetapkan kebijakan agar produk Anda dapat memiliki aturan akses, kuota penggunaan, dan ketentuan penggunaan yang berbeda. Jadi, jika Anda ingin mitra dan pemasok Anda memiliki hak akses yang berbeda ke API Inventaris Anda, tetapkan API ke dua produk yang berbeda.

Anda menggunakan portal Azure untuk menghubungkan API dengan produk.

Screenshot of Azure portal showing API Management with products section highlighted.

Untuk semua tingkat harga kecuali Konsumsi, ada dua produk default: Starter dan Unlimited. Produk Tidak Terbatas dirancang untuk manajemen API produksi, karena tidak memiliki batasan pada jumlah API yang terlampir. Anda dapat membuat produk baru sebanyak yang Anda butuhkan. Produk Starter memiliki batas lima panggilan/menit API, dan maksimum 100 panggilan API/minggu.