Mengimpor Azure Web App sebagai API

Artikel
06/01/2023

BERLAKU UNTUK: Semua tingkatAN API Management

Artikel ini menunjukkan cara mengimpor Azure Web App ke Azure API Management dan menguji API yang diimpor, menggunakan portal Microsoft Azure.

Catatan

Anda dapat menggunakan Ekstensi API Management untuk Visual Studio Code untuk mengimpor dan mengelola API Anda. Ikuti tutorial Ekstensi API Management untuk memasang dan memulai.

Dalam artikel ini, Anda akan mempelajari cara:

Mengimpor Aplikasi Web yang dihosting di App Service
Menguji API di portal Microsoft Azure

Mengekspos Aplikasi Web dengan API Management

Azure App Service adalah layanan berbasis HTTP untuk menghosting aplikasi web, API REST, dan backend seluler. Pengembang API dapat menggunakan tumpukan teknologi dan alur pilihan mereka untuk mengembangkan API dan menerbitkan backend API sebagai Aplikasi Web dalam lingkungan yang aman dan dapat diskalakan. Kemudian, gunakan API Management untuk mengekspos Aplikasi Web, mengelola dan melindungi API sepanjang siklus hidupnya, dan menerbitkannya kepada konsumen.

API Management adalah lingkungan yang direkomendasikan untuk mengekspos API yang dihosting Aplikasi Web, karena beberapa alasan:

Memisahkan pengelolaan dan pengamanan front end yang diekspos kepada konsumen API untuk mengelola dan memantau backend Aplikasi Web
Mengelola API web yang dihosting sebagai Aplikasi Web di lingkungan yang sama dengan API Anda yang lain
Menerapkan kebijakan untuk mengubah perilaku API, seperti pembatasan tarif panggilan
Mengarahkan konsumen API ke portal pengembang yang dapat disesuaikan dari API Management untuk ditemukan dan mempelajari tentang API, meminta akses, dan mencobanya

Untuk mengetahui informasi selengkapnya, lihat Tentang API Management.

Spesifikasi OpenAPI versus operasi karakter kartubebas

API Management mendukung impor Aplikasi Web yang dihosting di App Service yang menyertakan spesifikasi OpenAPI (definisi Swagger). Namun, spesifikasi OpenAPI tidak diperlukan.

Jika Aplikasi Web memiliki spesifikasi OpenAPI yang dikonfigurasi dalam definisi API, API Management membuat operasi API yang memetakan langsung ke definisi, termasuk jalur, parameter, dan jenis respons yang diperlukan.

Memiliki spesifikasi OpenAPI disarankan, karena API diimpor ke API Management dengan fidelitas tinggi, memberi Anda fleksibilitas untuk memvalidasi, mengelola, mengamankan, dan memperbarui konfigurasi untuk setiap operasi secara terpisah.
Jika spesifikasi OpenAPI tidak disediakan, API Management menghasilkan operasi karakter kartubebas untuk kata kerja HTTP umum (GET, PUT, dan sebagainya). Tambahkan jalur atau parameter yang diperlukan ke operasi karakter kartubebas untuk meneruskan permintaan API ke API backend.

Dengan operasi karakter kartubebas, Anda masih dapat memanfaatkan fitur API Management yang sama, tetapi operasi tidak ditentukan pada tingkat detail yang sama secara default. Dalam kedua kasus, Anda dapat mengedit atau menambahkan operasi ke API yang diimpor.

Contoh

Aplikasi Web backend Anda mungkin mendukung dua operasi GET:

https://myappservice.azurewebsites.net/customer/{id}
https://myappservice.azurewebsites.net/customers

Anda mengimpor Aplikasi Web ke layanan API Management di jalur seperti https://contosoapi.azureapi.net/store. Tabel berikut menunjukkan operasi yang diimpor ke API Management, baik dengan atau tanpa spesifikasi OpenAPI:

Jenis	Operasi yang diimpor	Sampel permintaan
spesifikasi OpenAPI	`GET /customer/{id}` `GET /customers`	`GET https://contosoapi.azureapi.net/store/customer/1` `GET https://contosoapi.azureapi.net/store/customers`
Kartubebas	`GET /*`	`GET https://contosoapi.azureapi.net/store/customer/1` `GET https://contosoapi.azureapi.net/store/customers`

Operasi karakter kartubebas memungkinkan permintaan yang sama ke layanan backend sebagai operasi dalam spesifikasi OpenAPI. Namun, operasi yang ditentukan OpenAPI dapat dikelola secara terpisah dalam API Management.

Prasyarat

Menyelesaikan mulai cepat berikut: Membuat instans Azure API Management.
Pastikan ada App Service di langganan Anda. Untuk mengetahui informasi selengkapnya, lihat Dokumentasi App Service.

Untuk langkah-langkah untuk membuat contoh API web dan menerbitkan sebagai Azure Web App, lihat:
- Tutorial: Membuat API web dengan ASP.NET Core
- Menerbitkan aplikasi ASP.NET Core ke Azure dengan Visual Studio Code

Membuka instans API Management Anda

Di portal Microsoft Azure, cari dan pilih layanan API Management.
Di halaman layanan API Management, pilih instans API Management Anda.

Mengimpor dan menerbitkan API backend

Tip

Langkah-langkah berikut memulai impor dengan menggunakan Azure API Management di portal Microsoft Azure. Anda juga dapat menautkan ke API Management langsung dari Aplikasi Web, dengan memilih API Management dari menu API aplikasi.

Navigasikan ke layanan API Management Anda di portal Microsoft Azure dan pilih API dari menu.
Pilih App Service dari daftar.
Pilih Telusuri untuk melihat daftar App Services di langganan Anda.
Pilih App Service. Jika definisi OpenAPI dikaitkan dengan Aplikasi Web yang dipilih, API Management akan mengambilnya dan mengimpornya.

Jika definisi OpenAPI tidak ditemukan, API Management akan mengekspos API dengan membuat operasi karakter kartubebas untuk kata kerja HTTP umum.
Menambahkan akhiran URL API. Akhiran adalah nama yang mengidentifikasi API khusus ini dalam instans API Management ini. Nama akhiran harus unik dalam instans APIM ini.
Publikasikan API dengan mengaitkan API dengan produk. Dalam hal ini, produk "Tidak Terbatas" digunakan. Jika Anda ingin API diterbitkan dan tersedia untuk pengembang, tambahkan API ke produk. Anda dapat melakukannya selama pembuatan API atau mengaturnya nanti.
Catatan

Produk adalah kumpulan dari satu atau beberapa API. Anda dapat menyertakan sejumlah API dan menawarkannya kepada pengembang melalui portal pengembang. Pengembang harus terlebih dahulu berlangganan produk untuk mendapatkan akses ke API. Saat berlangganan, mereka mendapatkan kunci langganan yang sesuai untuk API dalam produk tersebut. Jika Anda membuat instans APIM, Anda sudah menjadi administrator, jadi Anda berlangganan setiap produk secara default.

Secara default, setiap instans API Management dilengkapi dengan dua produk sampel:
- Starter
- Tidak Terbatas
Masukkan pengaturan API lainnya. Anda dapat mengatur nilai selama pembuatan atau mengkonfigurasinya nanti dengan masuk ke tab Pengaturan. Pengaturan dijelaskan dalam tutorial Mengimpor dan menerbitkan API pertama Anda.
Pilih Buat.

Menguji API baru di portal Microsoft Azure

Operasi dapat dipanggil langsung dari portal Microsoft Azure, yang menyediakan cara mudah untuk melihat dan menguji operasi API. Anda juga dapat menguji API di portal pengembang atau menggunakan alat klien REST Anda sendiri.

Memilih API yang Anda buat di langkah sebelumnya.
Pilih tab Uji.
Pilih operasi.

Halaman ini menampilkan bidang untuk parameter dan bidang kueri untuk header. Salah satu header adalah "Ocp-Apim-Subscription-Key", untuk kunci langganan produk yang terkait dengan API ini. Jika Anda membuat instans API Management, Anda sudah menjadi administrator, sehingga kunci terisi secara otomatis.
Tekan Kirim.

Saat pengujian berhasil, backend merespons dengan 200 OK dan beberapa data.

Menguji operasi karakter kartubebas di portal

Saat operasi karakter kartubebas dibuat, operasi mungkin tidak memetakan langsung ke backend API. Misalnya, operasi karakter kartubebas GET yang diimpor dalam API Management menggunakan jalur / secara default. Namun, backend API Anda mungkin mendukung operasi GET di jalur berikut:

/api/TodoItems

Anda dapat menguji jalur /api/TodoItems sebagai berikut.

Pilih API yang Anda buat, dan pilih operasi.
Pilih tab Uji.
Di parameter Template, perbarui nilai di samping nama karakter kartubebas (*). Misalnya, masukkan api/TodoItems. Nilai ini ditambahkan ke jalur / untuk operasi karakter kartubebas.
Pilih Kirim.