Memanggil API web dan REST API Anda sendiri dari alur kerja di Azure Logic Apps

Berlaku untuk: Azure Logic Apps (Consumption + Standard)

Saat Anda memiliki API web atau REST API yang ingin Anda panggil dari alur kerja di Azure Logic Apps, Anda harus terlebih dahulu menyelesaikan beberapa langkah penyiapan sebelum dapat memanggil API ini. Terutama, Anda harus menyebarkan API sebagai aplikasi web atau aplikasi API. Anda dapat melakukan tugas ini dengan menghosting API Anda di Azure App Service, platform cloud yang menyediakan hosting API yang sangat dapat diskalakan dan mudah.

Di App Service, Anda dapat menyebarkan API sebagai aplikasi web tetapi pertimbangkan untuk menyebarkan API Anda sebagai aplikasi API sebagai gantinya. Pendekatan ini membuat pekerjaan Anda lebih mudah ketika Anda membangun, menghosting, dan menggunakan API di cloud dan di lingkungan lokal. Anda tidak perlu mengubah kode apa pun di API Anda untuk disebarkan ke aplikasi API.

Anda dapat memanggil API apa pun dari alur kerja, tetapi untuk pengalaman terbaik, tambahkan metadata Swagger ke aplikasi web atau aplikasi API Anda. Dokumen Swagger ini menjelaskan operasi dan parameter API Anda, yang membantu alur kerja aplikasi logika bekerja dengan lebih baik dan lebih mudah dengan API Anda. Anda juga harus menyiapkan Berbagi Sumber Daya Lintas Asal (CORS) di aplikasi web atau aplikasi API Sehingga alur kerja Anda dapat mengakses API Anda.

Panduan ini menunjukkan cara menambahkan dokumen Swagger, menyiapkan CORS untuk aplikasi web atau aplikasi API Anda, dan menyediakan opsi untuk memanggil API Anda dari alur kerja setelah Anda menyelesaikan penyebaran dan hosting untuk API Anda di App Service.

Untuk informasi selengkapnya, lihat:

• Azure App Service
• Membuat dan menyebarkan aplikasi web ASP.NET
• Membuat host RESTful API dengan CORS di Azure App Service

Prasyarat

• Sebuah akun Azure dengan langganan aktif. Jika Anda tidak memiliki langganan, buat akun gratis.

• API web atau REST API yang mengikuti salah satu pola yang kompatibel dengan alur kerja di Azure Logic Apps dan disebarkan ke App Service sebagai aplikasi web atau aplikasi API.

  Untuk informasi selengkapnya, lihat:

  • Membuat dan menyebarkan aplikasi web ASP.NET
  • Membuat host RESTful API dengan CORS di Azure App Service

Menambahkan akses Swagger dan CORS ke aplikasi web atau aplikasi API Anda

Saat Anda menambahkan dokumen Swagger ke aplikasi web atau aplikasi API, perancang alur kerja di Azure Logic Apps dapat dengan lebih mudah menemukan dan menampilkan operasi dan parameter yang tersedia di API Anda. Anda juga harus menyiapkan Berbagi Sumber Daya Lintas Asal (CORS) di aplikasi web atau aplikasi API Sehingga alur kerja Anda dapat mengakses API Anda.

Untuk membuat dokumen Swagger Anda dapat dibaca dari alur kerja Anda di perancang, di aplikasi web atau aplikasi API Anda, atur properti definisi API dan akses CORS.

1. Di portal Microsoft Azure, temukan dan buka aplikasi web atau sumber daya aplikasi API Anda.

2. Pada bilah sisi sumber daya aplikasi, pilih Gambaran Umum.

3. Pada tab Properti , di bawah Domain, dari properti Domain default , salin dan simpan nama situs web di suatu tempat untuk langkah berikutnya.

4. Pada bilah sisi sumber daya aplikasi, di bawah API, pilih Definisi API. Untuk lokasi definisi API, masukkan URL untuk file JSON Swagger Anda, yang biasanya menggunakan format berikut, tetapi mungkin berbeda jika file Swagger Anda menggunakan spesifikasi API yang lebih baru:

   https://<website-name>/swagger/docs/v1

   Contoh berikut menunjukkan URL Swagger dengan spesifikasi API yang lebih baru:

   

5. Setelah selesai, pilih Simpan.

6. Pada bilah sisi sumber daya aplikasi, di bawah API, pilih CORS.

7. Untuk Asal yang Diizinkan, atur kebijakan CORS ke '*', yang berarti mengizinkan semua.

   Pengaturan ini mengizinkan permintaan dari perancang alur kerja di Azure Logic Apps.

   

8. Pada toolbar, pilih Simpan.

Untuk informasi selengkapnya, lihat Menghosting RESTful API dengan CORS di Azure App Service.

Memanggil API Anda dari alur kerja Anda

Setelah Anda menyiapkan URL definisi API dan CORS, operasi API Anda muncul di galeri konektor untuk Anda temukan dan tambahkan ke alur kerja Anda.

• Untuk melihat situs web yang memiliki URL OpenAPI, Anda dapat menelusuri situs web langganan Anda di perancang alur kerja.

• Untuk melihat tindakan dan input yang tersedia dengan mengarahkan ke dokumen Swagger, gunakan pemicu atau tindakan HTTP + Swagger .

• Untuk memanggil API apa pun, termasuk API yang tidak memiliki atau mengekspos dokumen Swagger, Anda selalu dapat membuat permintaan dengan tindakan HTTP.

Konten terkait

• Konektor kustom di Azure Logic Apps