Tutorial: Respons Mock API

Artikel
02/25/2025

BERLAKU UNTUK: Semua tingkatAN API Management

API Backend diimpor ke API Management (APIM) API atau dibuat dan dikelola secara manual. Langkah-langkah dalam tutorial ini menunjukkan kepada Anda cara:

Menggunakan API Management untuk membuat API HTTP kosong
Mengelola API HTTP secara manual
Menetapkan kebijakan pada API sehingga mengembalikan respons tiruan

Metode ini memungkinkan pengembang melanjutkan implementasi dan pengujian instans API Management meskipun backend tidak tersedia untuk mengirimkan respons nyata.

Tip

Tim API dapat menggunakan fitur ini di ruang kerja. Ruang kerja menyediakan akses administratif terisolasi ke API dan lingkungan runtime API mereka sendiri.

Kemampuan untuk meniru respons berguna dalam berbagai skenario:

Ketika fasad API dirancang terlebih dahulu dan implementasi backend dilakukan kemudian. Atau, backend sedang dikembangkan secara paralel.
Ketika backend untuk sementara tidak beroperasi atau tidak dapat menskalakan.

Dalam tutorial ini, Anda akan mempelajari cara:

Membuat API uji
Menambahkan operasi ke API uji
Mengaktifkan tiruan respons
Menguji API yang ditiru

Respons API yang ditiru

Prasyarat

Mempelajari terminologi Azure API Management.
Memahami konsep kebijakan dalam Azure API Management.
Menyelesaikan mulai cepat berikut: Membuat instans Azure API Management.

Membuat API uji

Langkah-langkah di bagian ini menunjukkan cara membuat API HTTP tanpa backend.

Masuk ke portal Microsoft Azure, kemudian navigasikan ke instans API Management Anda.
Pilih API>+ Tambahkan API>petak peta HTTP.
Pada jendela Membuat API HTTP, pilih Penuh.
Masukkan API Uji untuk Nama tampilan.
Pilih Tidak Terbatas untuk Produk.
Pastikan bahwa Terkelola dipilih untuk Gateway.
Pilih Buat.

Menambahkan operasi ke API uji

API mengekspos satu atau beberapa operasi. Di bagian ini, Anda akan menambahkan operasi ke API HTTP yang Anda buat. Memanggil operasi setelah menyelesaikan langkah-langkah di bagian ini memicu kesalahan. Setelah menyelesaikan langkah-langkah di bagian Mengaktifkan peniruan respons, Anda tidak akan mendapatkan kesalahan.

Portal
Azure CLI

Memilih API yang Anda buat di langkah sebelumnya.
Pilih + Tambahkan Operasi.

Di jendela Frontend, masukkan nilai berikut ini.

Ujung depan jendela

Pengaturan	Nilai	Deskripsi
Nama tampilan	Panggilan uji	Nama yang ditampilkan di portal pengembang.
URL (kata kerja HTTP)	GET	Pilih salah satu kata kerja HTTP yang telah ditentukan sebelumnya.
URL	/test	Jalur URL untuk API.
Deskripsi		Deskripsi opsional operasi, digunakan untuk memberikan dokumentasi di portal pengembang kepada pengembang menggunakan API ini.

Pilih tab Respons, yang terletak di bawah bidang URL, Nama tampilan, dan Deskripsi. Masukkan pengaturan pada tab ini untuk menentukan kode status respons, jenis konten, contoh, dan skema.
Pilih + Tambahkan respons, dan pilih 200 OK dari daftar.
Di bawah judul Representasi di sebelah kanan, pilih + Tambahkan representasi.
Masukkan aplikasi/json ke dalam kotak pencarian dan pilih jenis konten aplikasi/json.
Dalam kotak teks Sampel, masukkan { "sampleField" : "test" }.
Pilih Simpan.

Meskipun tidak diperlukan untuk contoh ini, Anda dapat mengonfigurasi pengaturan tambahan untuk operasi API di tab lain, termasuk:

Tab	Deskripsi
Kueri	Menambahkan parameter kueri. Selain memberikan nama dan deskripsi, Anda juga dapat menyediakan nilai yang ditetapkan ke parameter kueri. Anda dapat menandai salah satu nilai tersebut sebagai default (opsional).
Permintaan	Tentukan jenis konten permintaan, contoh, dan skema.

Untuk mulai menggunakan Azure CLI:

Gunakan lingkungan Bash di Azure Cloud Shell. Untuk informasi selengkapnya, lihat Mulai Cepat untuk Bash di Azure Cloud Shell.
Jika Anda lebih suka menjalankan perintah referensi CLI secara lokal, instal Azure CLI. Jika Anda menjalankan Windows atau macOS, pertimbangkan untuk menjalankan Azure CLI dalam kontainer Docker. Untuk informasi lebih lanjut, lihat Cara menjalankan Azure CLI di kontainer Docker.
- Jika Anda menggunakan instalasi lokal, masuk ke Azure CLI dengan menggunakan perintah login az. Untuk menyelesaikan proses autentikasi, ikuti langkah-langkah yang ditampilkan di terminal Anda. Untuk opsi masuk lainnya, lihat Masuk dengan Azure CLI.
- Saat Anda diminta, instal ekstensi Azure CLI pada penggunaan pertama. Untuk informasi selengkapnya tentang ekstensi, lihat Menggunakan ekstensi dengan Azure CLI.
- Jalankan versi az untuk menemukan versi dan pustaka dependen yang diinstal. Untuk meningkatkan ke versi terbaru, jalankan peningkatan az.

Untuk menambahkan operasi ke API uji, jalankan perintah buat az apim operasi:

az apim api operation create --resource-group apim-hello-word-resource-group \
    --display-name "Test call" --api-id test-api --method GET \
    --url-template /test --service-name apim-hello-world

Jalankan perintah daftar operasi api apim az untuk melihat semua operasi Anda untuk API:

az apim api operation list --resource-group apim-hello-word-resource-group \
    --api-id test-api --service-name apim-hello-world --output table

Untuk menghapus operasi, gunakan perintah hapus operasi api apim az. Dapatkan ID operasi dari perintah sebelumnya.

az apim api operation delete --resource-group apim-hello-word-resource-group \
    --api-id test-api --operation-id 00000000000000000000000000000000 \
    --service-name apim-hello-world

Pertahankan operasi ini untuk digunakan di sisa artikel ini.

Mengaktifkan tiruan respons

Pilih API yang Anda buat di Buat API uji.
Di jendela di sebelah kanan, pastikan bahwa tab Desain dipilih.
Pilih operasi uji yang Anda tambahkan.
Di jendela Pemrosesan masuk, pilih + Tambahkan kebijakan.
Pilih Respons tiruan dari galeri.
Dalam kotak teks respons API Management, ketik 200 OK, aplikasi/json. Pilihan ini menunjukkan bahwa API Anda harus mengembalikan sampel respons yang Anda tentukan di bagian sebelumnya.
Pilih Simpan.

Tip

Bilah kuning dengan teks Peniruan diaktifkan ditampilkan. Ini menandakan bahwa respons yang dikembalikan dari API Management ditiru oleh kebijakan peniruan dan tidak dihasilkan oleh backend.

Menguji API yang ditiru

Pilih API yang Anda buat di Buat API uji.
Pilih tab Uji.
Pastikan API Panggilan uji dipilih, kemudian pilih Kirim untuk melakukan panggilan pengujian.
Respons HTTP menampilkan JSON yang disediakan sebagai sampel di bagian pertama tutorial.