Mengimpor Azure Container 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 telah diimpor dengan menggunakan portal Azure. Dalam artikel ini, Anda akan mempelajari cara:

Mengimpor Container App yang mengekspos API Web
Menguji API di portal Microsoft Azure

Mengekspos Container App dengan API Management

Azure Container Apps memungkinkan Anda dalam menyebarkan aplikasi kontainer tanpa mengelola infrastruktur yang kompleks. Pengembang API dapat menulis kode menggunakan bahasa pemrogram atau kerangka kerja pemrograman pilihan mereka, membangun layanan mikro dengan dukungan penuh untuk Distributed Application Runtime (Dapr), dan menskalakan berdasarkan lalu lintas HTTP atau kejadian lainnya.

API Management adalah lingkungan yang direkomendasikan untuk mengekspos API web yang dihosting Container App alasan berikut:

Memisahkan antara pengelolaan dan pengamanan front end yang diekspos kepada konsumen API agar tidak mengelola dan memantau backend API web
Mengelola API web yang dihosting sebagai Container Apps 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 Container Apps yang menyediakan spesifikasi OpenAPI (definisi Swagger). Namun, spesifikasi OpenAPI tidak diperlukan. Sebaiknya berikan spesifikasi OpenAPI. API Management dapat mengimpor operasi individual, sehingga Anda dapat memvalidasi, mengelola, mengamankan, dan memperbarui konfigurasi untuk setiap operasi secara terpisah.

Jika Container App mengekspos spesifikasi OpenAPI, API Management akan membuat operasi API yang memetakan secara langsung ke definisi. API Management akan melihat Spesifikasi OpenAPI di beberapa lokasi

Konfigurasi Container App.
/openapi.json
/openapi.yml
/swagger/v1/swagger.json

Jika spesifikasi OpenAPI tidak disediakan, API Management menghasilkan operasi karakter kartubebas untuk kata kerja HTTP umum (GET, PUT, dan sebagainya). Anda masih dapat memanfaatkan fitur API Management yang sama, tetapi operasi tidak akan ditentukan pada tingkat detail yang sama.

Dalam kedua kasus, Anda dapat mengedit atau menambahkan operasi ke API yang diimpor.

Contoh

Container App backend Anda mungkin mendukung dua operasi GET:

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

Anda mengimpor Container App ke layanan API Management di jalur seperti https://contosoapi.azure-api.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.azure-api.net/store/customer/1` `GET https://contosoapi.azure-api.net/store/customers`
Kartubebas	`GET /*`	`GET https://contosoapi.azure-api.net/store/customer/1` `GET https://contosoapi.azure-api.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 bahwa ada Container App yang mengekspos API Web di langganan Anda. Untuk informasi lebih lanjut, lihat Dokumentasi Container Apps.

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

Navigasikan ke layanan API Management Anda di portal Microsoft Azure dan pilih API dari menu.
Pilih Container App dari daftar.
Pilih Telusuri untuk melihat daftar Container Apps di langganan Anda.
Pilih Container App. Jika definisi OpenAPI dikaitkan dengan Container App 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. Akhiran harus unik dalam instans API Management 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.
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 telah membuat instans API Management, artinya Anda telah menjadi administrator dan sudah berlangganan ke setiap produk secara default.

Setiap instans API Management dilengkapi dengan dua produk sampel saat dibuat:
- 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 headernya 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.