Menambahkan API secara manual

BERLAKU UNTUK: Semua tingkatan API Management

Artikel ini memperlihatkan cara menambahkan API secara manual ke Azure API Management. Saat ingin membuat respons tiruan dari API, Anda dapat membuat API kosong. Untuk informasi tentang membuat respons API tiruan, lihat Respons Api Tiruan.

Jika Anda ingin mengimpor API yang sudah ada, lihat bagian Konten terkait di artikel ini.

Dalam artikel ini, Anda mempelajari cara membuat API kosong. Anda akan menentukan httpbin.org (layanan pengujian publik) sebagai API backend.

Prasyarat

• Selesaikan langkah cepat Membuat instans Azure API Management.

Pergi ke instans API Management Anda

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

   

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

   

Buat API

1. Di bawah API di menu sebelah kiri, pilih API.

2. Pilih + Tambahkan API.

3. Pilih ubin HTTP:

   

4. Masukkan URL layanan Web backend (misalnya, https://httpbin.org) dan pengaturan lain untuk API. Pengaturan dijelaskan dalam tutorial ​​Impor dan publikasikan API pertama Anda.

5. Pilih Buat.

Pada titik ini, Anda tidak memiliki operasi di API Management yang memetakan ke operasi di API backend Anda. Jika Anda memanggil operasi yang diekspos melalui backend tetapi tidak melalui API Management, Anda mendapatkan kesalahan 404.

Catatan

Secara default, saat Anda menambahkan API, meskipun terhubung ke layanan backend, API Management tidak akan mengekspos operasi apa pun sampai Anda mengizinkannya. Untuk mengizinkan operasi layanan backend Anda, buat operasi API Management yang memetakan ke operasi backend.

Tambahkan dan uji operasi

Bagian ini memperlihatkan cara menambahkan /get operasi untuk memetakannya ke operasi backend http://httpbin.org/get .

Tambahkan operasi

1. Memilih API yang Anda buat di langkah sebelumnya.
2. Pilih + Tambahkan operasi.
3. Di URL, pilih GET dan masukkan /get di kotak teks.
4. Di Nama tampilan, masukkan FetchData.
5. Pilih Simpan.

Uji operasinya

Uji operasi di portal Microsoft Azure. (Anda juga dapat mengujinya di portal pengembang.)

1. Pilih tab Uji.
2. Pilih FetchData.
3. Pilih Kirim.

Respons yang dihasilkan oleh operasi http://httpbin.org/get muncul di bagian respons HTTP. Jika Anda ingin mengubah operasi Anda, lihat Mengubah dan melindungi API Anda.

Tambahkan dan uji operasi berparameter

Bagian ini menunjukkan cara menambahkan operasi yang membutuhkan parameter. Dalam contoh ini, Anda memetakan operasi ke http://httpbin.org/status/200.

Tambahkan operasi

1. Pilih API yang Anda buat sebelumnya.
2. Pada tab Desain , pilih + Tambahkan operasi.
3. Di URL, pilih GET dan masukkan /status/{code} di kotak teks.
4. Di Nama tampilan, masukkan GetStatus.
5. Pilih Simpan.

Uji operasinya

Uji operasi di portal Microsoft Azure. (Anda juga dapat mengujinya di portal pengembang.)

1. Pilih tab Uji.

2. Pilih GetStatus. Dalam kode, masukkan 200.

3. Pilih Kirim.

   Respons yang dihasilkan oleh operasi http://httpbin.org/status/200 muncul di bagian respons HTTP. Jika Anda ingin mengubah operasi Anda, lihat Mengubah dan melindungi API Anda.

Tambah dan uji proses wildcard

Bagian ini menunjukkan cara menambahkan operasi wildcard. Operasi wildcard memungkinkan Anda meneruskan nilai arbitrer melalui permintaan API. Alih-alih membuat operasi GET terpisah seperti yang ditunjukkan di bagian sebelumnya, Anda dapat membuat operasi GET wildcard.

Perhatian

Berhati-hatilah saat Anda mengonfigurasi operasi wildcard. Konfigurasi ini mungkin membuat API lebih rentan terhadap ancaman keamanan API tertentu.

Tambahkan operasi

1. Pilih API yang Anda buat sebelumnya.
2. Pada tab Desain , pilih + Tambahkan operasi.
3. Di URL, pilih GET dan masukkan /* di kotak teks.
4. Di Nama tampilan, masukkan WildcardGet.
5. Pilih Simpan.

Uji operasinya

Uji operasi di portal Microsoft Azure. (Anda juga dapat mengujinya di portal pengembang.)

1. Pilih tab Uji.

2. Pilih WildcardGet. Cobalah operasi GET yang Anda uji di bagian sebelumnya, atau coba operasi GET lainnya yang didukung.

   Misalnya, dalam Parameter templat, ubah nilai di samping nama kartubebas (*) menjadi header. Operasi ini mengembalikan header HTTP permintaan masuk.

3. Pilih Kirim.

   Respons yang dihasilkan oleh operasi http://httpbin.org/headers muncul di bagian respons HTTP. Jika Anda ingin mengubah operasi Anda, lihat Mengubah dan melindungi API Anda.

Catatan

Penting untuk memahami bagaimana host dalam API backend yang sedang Anda integrasikan menangani garis miring di akhir pada URL operasi. Untuk informasi selengkapnya, lihat Tanya Jawab Umum (FAQ) API Management.

Menambahkan API lainnya

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

• Spesifikasi OpenAPI
• Sebuah 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:

   

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

   

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

4. Pilih Impor dari menu drop-down:

   

5. Pilih layanan untuk mengimpor API.

Konten terkait

• Batasan impor API
• Mengimpor spesifikasi OpenAPI
• Mengimpor SOAP API
• Mengimpor SOAP API dan mengonversinya ke REST
• Impor API dari App Service
• Mengimpor API aplikasi kontainer
• Mengimpor API WebSocket
• Mengimpor sebuah API GraphQL
• Mengimpor skema GraphQL dan menyiapkan penyelesai bidang
• Mengimpor API aplikasi fungsi
• Mengimpor API aplikasi logika
• Mengimpor layanan Service Fabric
• Mengimpor API Azure AI Foundry
• Memasukkan API Azure OpenAI
• Mengimpor LLM API
• Mengimpor API OData
• Mengekspor REST API sebagai server MCP
• Mengekspos server MCP yang ada
• Mengimpor API agen A2A
• Impor metadata SAP OData
• Mengimpor API gRPC
• Edit API