Bagikan melalui

Menambahkan API secara manual

  • Artikel

BERLAKU UNTUK: Semua tingkatAN API Management

Artikel ini menunjukkan langkah-langkah untuk menambahkan API secara manual ke instans API Management. Saat ingin membuat tiruan API, Anda dapat membuat API kosong atau menetapkannya secara manual. Untuk detail tentang membuat API tiruan, lihat Respons Mock API.

Jika Anda ingin mengimpor API yang sudah ada, lihat bagian topik terkait.

Dalam artikel ini, kami membuat API kosong dan menetapkan httpbin.org (layanan pengujian publik) sebagai API backend.

Prasyarat

Selesaikan panduan mulai cepat berikut: Memulai instans Azure API Management

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

Buat API

  1. Navigasikan ke layanan API Management Anda di portal Microsoft Azure dan pilih API dari menu.
  2. Dari menu sebelah kiri, pilih + Tambahkan API.
  3. Pilih HTTP dari daftar.
    API Kosong
  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 back end tetapi tidak melalui API Management, Anda mendapatkan 404.

Catatan

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

Tambahkan dan uji operasi

Bagian ini menunjukkan bagaimana menambahkan operasi "/get" untuk memetakannya ke operasi back end "http://httpbin.org/get".

Tambahkan operasi

  1. Memilih API yang Anda buat di langkah sebelumnya.
  2. Pilih + Tambahkan Operasi.
  3. Di URL, pilih DAPATKAN dan masukkan /get di sumber daya.
  4. Masukkan "FetchData" untuk Nama tampilan.
  5. Pilih Simpan.

Uji operasi

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

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

Respons yang dihasilkan oleh operasi "http://httpbin.org/get" akan muncul. 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 kasus ini, kita memetakan operasi ke "http://httpbin.org/status/200".

Tambahkan operasi

  1. Memilih API yang Anda buat di langkah sebelumnya.
  2. Pilih + Tambahkan Operasi.
  3. Di URL, pilih DAPATKAN dan masukkan /status/{code} di sumber daya. Secara opsional, Anda dapat memberikan beberapa informasi yang terkait dengan parameter ini. Misalnya, masukkan "Angka" untuk JENIS, "200" (default) untuk NILAI .
  4. Masukkan "GetStatus" untuk Nama tampilan.
  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. Secara default, nilai kode ditetapkan ke "200". Anda dapat mengubahnya untuk menguji nilai lain. Misalnya, ketik "418".

  3. Tekan Kirim.

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

Menambahkan dan menguji operasi wildcard

Bagian ini memperlihatkan cara menambahkan operasi wildcard. Operasi wildcard memungkinkan Anda melewati nilai sembarang dengan permintaan API. Alih-alih membuat operasi GET terpisah seperti yang ditunjukkan di bagian sebelumnya, Anda dapat membuat operasi GET wildcard.

Perhatian

Gunakan perawatan saat mengonfigurasi operasi kartubebas. Konfigurasi ini dapat membuat API lebih rentan terhadap ancaman keamanan API tertentu.

Tambahkan operasi

  1. Memilih API yang Anda buat di langkah sebelumnya.
  2. Pilih + Tambahkan Operasi.
  3. Di URL, pilih DAPATKAN dan masukkan /* di sumber daya.
  4. Masukkan "WildcardGet" untuk Nama tampilan.
  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.

    Contohnya, di Parameter templat, perbarui nilai di samping nama wildcard (*) menjadiheaders. Operasi ini mengembalikan header HTTP permintaan masuk.

  3. Tekan Kirim.

    Respons yang dihasilkan oleh operasi "http://httpbin.org/headers" akan muncul. Jika Anda ingin mengubah operasi Anda, lihat Mengubah dan melindungi API Anda.

Catatan

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

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

Langkah berikutnya

Mengubah dan memproteksi API yang diterbitkan