Mengimpor metadata OData SAP sebagai API

BERLAKU UNTUK: Semua tingkatan manajemen API

Artikel ini menjelaskan cara mengimpor layanan OData (Open Data Protocol) ke Azure API Management dengan menggunakan metadata OData. Contoh berikut menggunakan SAP Gateway Foundation.

Dalam artikel ini, Anda akan mempelajari cara:

• Mengambil metadata OData dari layanan SAP Anda
• Impor metadata OData ke Azure API Management, baik secara langsung atau setelah mengonversinya ke spesifikasi OpenAPI
• Menyelesaikan konfigurasi API
• Menguji API di portal Azure

Prasyarat

• Buat instans API Management.

• Sistem dan layanan SAP yang diekspos sebagai OData v2 atau v4.

• Jika backend SAP Anda menggunakan sertifikat yang ditandatangani sendiri (untuk pengujian), Anda mungkin perlu menonaktifkan verifikasi rantai kepercayaan untuk SSL. Untuk melakukan tindakan tersebut, konfigurasikan backend di instans API Management Anda:

  1. Di portal Microsoft Azure, di bawah API, pilih Backend+>Buat backend baru.
  2. Tambahkan URL Kustom yang menunjuk ke layanan backend SAP.
  3. Perluas bagian Tingkat Lanjut , lalu kosongkan kotak centang Validasi rantai sertifikat dan Validasi nama sertifikat .

  Catatan

  Dalam skenario produksi, gunakan sertifikat yang tepat untuk verifikasi SSL end-to-end.

  Tips

  Untuk cakupan fitur lengkap API Management, konversikan SAP OData API ke spesifikasi OpenAPI sebelum mendaftar.

Mengambil metadata OData dari layanan SAP Anda

Gunakan salah satu metode berikut untuk mengambil XML metadata dari layanan SAP Anda. Jika Anda berencana untuk mengonversi XML metadata ke spesifikasi OpenAPI, simpan file secara lokal.

• Gunakan Klien Gateway SAP (transaksi /IWFND/GW_CLIENT).
• Lakukan panggilan HTTP langsung untuk mengambil XML: http://<OData server URL>:<port>/<path>/$metadata.
• Gunakan SAP Business Accelerator Hub jika berlaku.

Pergi ke instance API Management Anda

1. Di portal Microsoft Azure, cari dan pilih layanan API Management:

   

2. Pada halaman layanan API Management , pilih instans API Management Anda:

   

Mengimpor API ke API Management

Pilih salah satu metode berikut untuk mengimpor API Anda ke API Management:

• KonversiKAN XML metadata ke spesifikasi OpenAPI (disarankan).
• Impor XML metadata sebagai API OData secara langsung.

Spesifikasi OpenAPI (disarankan)

Mengonversi metadata OData ke JSON OpenAPI

1. Gunakan Microsoft converter yang dibangun di atas alat sumber terbuka OASIS.

   Contoh berikut mengonversi XML OData v2 untuk layanan epm_ref_apps_prod_man_srvpengujian :

   oasis-converter convert epm_ref_apps_prod_man_srv.xml api.json
   

   Catatan

   Untuk pengujian dengan satu file XML, Anda dapat menggunakan pengalaman berbasis web.

2. Simpan file openapi-spec.json secara lokal untuk diimpor ke API Management.

Impor spesifikasi OpenAPI

1. Di menu bar samping, di bagian API , pilih API.

2. Di bawah Buat dari definisi, pilih petak OpenAPI:

   

3. Pilih Pilih file, lalu pilih file openapi-spec.json yang Anda simpan secara lokal di langkah sebelumnya.

4. Masukkan pengaturan API. Anda dapat mengatur nilai-nilai ini saat mengimpor API atau mengonfigurasinya nanti dengan masuk ke tab Pengaturan .

   • Untuk akhiran URL API, sebaiknya gunakan jalur URL yang sama dengan layanan SAP asli.

   • Untuk informasi selengkapnya tentang pengaturan API, lihat tutorial Mengimpor dan menerbitkan API pertama Anda.

5. Pilih Buat.

Anda juga perlu mengonfigurasi autentikasi ke backend Anda dengan menggunakan metode yang sesuai untuk lingkungan Anda. Misalnya, lihat Autentikasi dan otorisasi.

Catatan

Untuk informasi tentang batasan impor API, lihat Pembatasan impor API dan masalah yang diketahui.

Uji API Anda

1. Navigasi ke instans API Management Anda.

2. Di menu bar samping, pilih API>API.

3. Di bagian Semua API, pilih API yang telah Anda impor.

4. Pilih tab Uji untuk mengakses konsol Uji.

5. Pilih operasi, masukkan nilai yang diperlukan, lalu pilih Kirim.

   Misalnya, uji GET /$metadata panggilan untuk memverifikasi konektivitas ke backend SAP.

6. Tampilkan responsnya. Untuk memecahkan masalah, lacak panggilan.

7. Setelah selesai menguji, keluar dari konsol pengujian.

OData Metadata

Mengimpor metadata OData

1. Di menu bar samping, pilih API>, lalu pilih + Tambahkan API.

2. Di bawah Buat dari definisi, pilih petak OData

   

3. Masukkan pengaturan API. Anda dapat memperbarui pengaturan nanti dengan masuk ke tab Pengaturan API.

   1. Dalam spesifikasi OData, masukkan URL untuk titik akhir metadata OData. Nilai ini biasanya adalah URL ke induk layanan, ditambahkan dengan /$metadata. Atau, pilih file XML OData lokal untuk diimpor.

   2. Masukkan pengaturan tambahan untuk mengonfigurasi API Anda. Pengaturan ini dijelaskan dalam tutorial Impor dan terbitkan API pertama Anda.

4. Pilih Buat.

   API ditambahkan ke daftar API. Kumpulan entitas dan fungsi yang diekspos dalam deskripsi metadata OData muncul di tab Kumpulan entitas dan fungsi API.

   

Memperbarui skema OData

Anda dapat mengakses editor di portal untuk melihat skema OData API Anda. Jika API berubah, Anda juga dapat memperbarui skema di API Management dari file atau titik akhir layanan OData.

1. Di menu bar samping, API API>, lalu pilih API OData Anda.

2. Pada tab Kumpulan entitas dan fungsi , pilih elipsis (...) di samping kumpulan entitas atau fungsi, lalu pilih Edit.

   

3. Tinjau skema. Jika Anda ingin memperbaruinya, pilih Perbarui dari file atau Perbarui skema dari titik akhir.

   

Menguji API OData Anda

1. Di menu bar samping, API API>, lalu pilih API OData Anda.

2. Pada tab Kumpulan entitas dan fungsi , pilih elipsis (...) di samping set entitas atau fungsi, lalu pilih Uji.

   

3. Di konsol pengujian, masukkan parameter templat, parameter kueri, dan header untuk pengujian Anda, lalu pilih Uji. Untuk informasi selengkapnya tentang menguji API di portal, lihat Menguji API baru di portal.

Mengamankan API OData Anda

Amankan API OData Anda dengan menerapkan kebijakan autentikasi dan otorisasi yang ada dan kebijakan validasi OData untuk melindungi dari serangan melalui permintaan API OData.

Tips

Di portal, konfigurasikan kebijakan untuk API OData Anda pada tab kebijakan API.

Pertimbangan produksi

• Gunakan Defender untuk API untuk perlindungan siklus hidup penuh, deteksi, dan cakupan respons untuk API.
• Lihat contoh skenario end-to-end untuk mengintegrasikan API Management dengan gateway SAP.
• Mengontrol akses ke backend SAP dengan menggunakan kebijakan API Management. Misalnya, jika API diimpor sebagai API OData, gunakan kebijakan validasi permintaan OData. Ada juga cuplikan kebijakan untuk penyebaran utama SAP untuk SAP ECC atau S/4HANA atau SAP SuccessFactors dan menggunakan token X-CSRF.
• Untuk panduan tentang menyebarkan, mengelola, dan memigrasikan API dalam skala besar, lihat:
  • Penyebaran API Otomatis dengan APIOps
  • Menggunakan DevOps dan CI/CD untuk menerbitkan API

Konten terkait

• Pembatasan impor API
• Mengimpor spesifikasi OpenAPI
• Mengimpor API SOAP
• Mengimpor SOAP API dan mengonversinya ke REST
• Impor API Layanan Aplikasi
• Mengimpor API aplikasi kontainer
• Impor API WebSocket
• Mengimpor sebuah API GraphQL
• Mengimpor skema GraphQL dan menyiapkan penyelesai bidang
• Mengimpor API aplikasi fungsi
• Mengimpor API aplikasi logika
• Mengimpor layanan Service Fabric
• Mengimpor MICROSOFT Foundry API
• Impor API Azure OpenAI
• Mengimpor LLM API
• Mengimpor API OData
• Mengekspor REST API sebagai server MCP
• Mengekspos server MCP yang ada
• Mengimpor API agen A2A
• Impor metadata SAP OData
• Impor sebuah API gRPC
• Mengedit API