Tutorial: Respons Mock API

BERLAKU UNTUK: Semua tingkat API Management

API backend diimpor ke API Azure API Management atau dibuat dan dikelola secara manual. Langkah-langkah dalam tutorial ini menjelaskan cara:

• Gunakan API Management untuk membuat API HTTP kosong.
• Mengelola API HTTP secara manual.
• Tetapkan kebijakan pada API sehingga mengembalikan respons tiruan.

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

Kiat

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 membuat respons tiruan berguna dalam banyak skenario:

• Ketika fasad API dirancang terlebih dahulu dan implementasi backend terjadi nanti, atau ketika backend sedang dikembangkan secara paralel.
• Ketika backend sementara tidak beroperasi atau tidak dapat menskalakan.

Dalam tutorial ini, Anda akan mempelajari cara:

• Membuat API uji
• Menambahkan operasi ke API uji
• Mengaktifkan pemalsuan respons
• Menguji API yang ditiru

Prasyarat

• Pelajari terminologi API Management.
• Pahami konsep kebijakan dalam API Management.
• Selesaikan panduan memulai cepat untuk membuat instans Azure API Management.

Membuat API uji

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

1. Masuk ke portal Microsoft Azure, kemudian navigasikan ke instans API Management Anda.

2. Pilih API>+ Tambahkan API>petak HTTP:

   

3. Pada jendela Membuat API HTTP, pilih Penuh.

4. Di Nama tampilan, masukkan Test API.

5. Di Produk, pilih Tidak Terbatas, jika nilai tersebut tersedia. Nilai ini hanya tersedia di beberapa tingkatan. Anda dapat membiarkan nilai kosong untuk tutorial ini, tetapi Anda perlu mengaitkan API dengan produk untuk menerbitkannya. Untuk informasi selengkapnya, lihat Mengimpor dan menerbitkan API pertama Anda.

6. Di Gateway, pilih Terkelola jika opsi ini tersedia. (Opsi ini hanya tersedia di tingkat layanan tertentu.)

7. Pilih Buat.

   

Menambahkan operasi ke API uji

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

Portal

1. Pilih API yang Anda buat di langkah sebelumnya.

2. Pilih + Tambahkan Operasi.

3. Di jendela Frontend , masukkan nilai berikut ini:

   Pengaturan	Nilai	Deskripsi
   Nama tampilan	Panggilan uji	Nama yang ditampilkan di portal pengembang.
   URL (kotak pertama)	DAPATKAN	Pilih salah satu kata kerja HTTP yang telah ditentukan sebelumnya.
   URL (kotak kedua)	/ujian	Jalur URL untuk API.
   Deskripsi		Deskripsi opsional operasi. Ini menyediakan dokumentasi di portal pengembang kepada pengembang yang menggunakan API.

   

4. Pilih tab Respons , yang terletak di bawah kotak URL, Nama tampilan, dan Deskripsi . Anda akan memasukkan nilai pada tab ini untuk menentukan kode status respons, jenis konten, contoh, dan skema.

5. Pilih + Tambahkan respons, lalu pilih 200 OK dari daftar.

   

6. Di bagian Representasi , pilih + Tambahkan representasi.

7. Masukkan aplikasi/json ke dalam kotak pencarian lalu pilih jenis konten aplikasi/json .

8. Dalam kotak Sampel , masukkan { "sampleField" : "test" }.

9. Pilih Simpan.

   

Meskipun tidak diperlukan untuk contoh ini, Anda dapat mengonfigurasi lebih banyak pengaturan untuk operasi API pada tab lain, seperti yang dijelaskan dalam tabel berikut:

Tab	Deskripsi
Kueri	Tambahkan 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.

Azure CLI

Untuk mulai menggunakan Azure CLI:

• Gunakan lingkungan Bash di Azure Cloud Shell. Untuk informasi selengkapnya, lihat Mulai menggunakan 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 Mengautentikasi ke Azure menggunakan Azure CLI.

  • Saat Anda diminta, instal ekstensi Azure CLI pada penggunaan pertama. Untuk informasi selengkapnya tentang ekstensi, lihat Menggunakan dan mengelola ekstensi dengan Azure CLI.

  • Jalankan versi az untuk menemukan versi dan pustaka dependen yang diinstal. Untuk meningkatkan ke versi terbaru, jalankan az upgrade.

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

az apim api operation create --resource-group <resource-group> \
    --display-name "Test call" --api-id test-api --method GET \
    --url-template /test --service-name <API-management-service-name> 

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

az apim api operation list --resource-group <resource-group-name> \
    --api-id test-api --service-name <API-management-service-name> --output table

Pertahankan operasi ini untuk digunakan di sisa artikel ini. Jika Anda ingin menghapus operasi, Anda dapat menggunakan perintah az apim api operation delete . Dapatkan ID operasi dari perintah sebelumnya.

az apim api operation delete --resource-group <resource-group-name> \
    --api-id test-api --operation-id <ID> \
    --service-name <API-management-service-name>

Mengaktifkan pemalsuan respons

1. Pilih API yang Anda buat di Buat API uji.

2. Pastikan tab Desain dipilih.

3. Pilih operasi uji yang Anda tambahkan.

4. Di bagian Pemrosesan masuk, pilih + Tambahkan kebijakan.

   

5. Pilih petak peta Respons tiruan dari galeri:

   

6. Pastikan 200 OK, application/json muncul di kotak respons API Management. Pilihan ini menunjukkan bahwa API Anda harus mengembalikan sampel respons yang Anda tentukan di bagian sebelumnya.

   

7. Pilih Simpan.

   Kiat

   Bilah kuning yang menampilkan teks Mocking diaktifkan muncul. Pesan ini menunjukkan bahwa respons yang dikembalikan oleh API Management disimulasikan oleh kebijakan tiruan dan tidak diproduksi oleh backend.

Menguji API yang ditiru

1. Pilih API yang Anda buat di Buat API uji.

2. Pada tab Uji , pastikan bahwa UJI API panggilan dipilih, lalu pilih Kirim untuk melakukan panggilan pengujian:

   

3. Respons HTTP menampilkan JSON yang disediakan sebagai sampel di bagian pertama tutorial:

   

Langkah berikutnya

Buka tutorial berikutnya:

Mengubah dan memproteksi API yang diterbitkan