Mengimpor metadata OData SAP sebagai API

BERLAKU UNTUK: Semua tingkatan API Management

Artikel ini menjelaskan cara mengimpor layanan OData dengan menggunakan deskripsi metadatanya. SAP Gateway Foundation digunakan sebagai contoh.

Dalam artikel ini, Anda:

• 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 Microsoft Azure

Prasyarat

• Instans Manajemen API. Jika Anda tidak memilikinya, selesaikan langkah-langkah dalam Membuat instans API Management dengan menggunakan portal Microsoft Azure.

• 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 Azure, di bagian API, pilih Backends>+ Tambahkan.
  2. Tambahkan URL Kustom yang menunjuk ke layanan backend SAP.
  3. Kosongkan kotak centang Validasi rantai sertifikat dan Validasi nama sertifikat .

  Catatan

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

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).
  atau
• Lakukan panggilan HTTP langsung untuk mengambil XML: http://<OData server URL>:<port>/<path>/$metadata.

Pergi ke instance API Management Anda

1. Di portal 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:

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

OData Metadata

Mengimpor metadata OData

1. Di menu sebelah kiri, pilih API>, lalu pilih + Tambahkan API.

2. Di bawah Buat dari definisi, pilih 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 root 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 portal, navigasikan ke instans API Management Anda.

2. Di menu sebelah kiri, pilih API, lalu pilih API OData Anda.

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

   

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

   

Menguji API OData Anda

1. Di menu sebelah kiri, pilih 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.

spesifikasi OpenAPI

Mengonversi metadata OData ke JSON OpenAPI

1. Konversikan XML OData ke format JSON OpenAPI. Gunakan alat sumber terbuka OASIS untuk OData v2 atau OData v4, bergantung pada XML metadata Anda.

   Contoh berikut mengonversi XML OData v2 untuk layanan epm_ref_apps_prod_man_srvpengujian :

   odata-openapi -p --basePath '/sap/opu/odata/sap/epm_ref_apps_prod_man_srv' \
    --scheme https --host <your IP address>:<your SSL port> \
    ./epm_ref_apps_prod_man_srv.xml
   

   Catatan

   • Untuk pengujian dengan satu file XML, Anda dapat menggunakan pengonversi berbasis web yang didasarkan pada alat sumber terbuka.
   • Dengan alat atau pengonversi berbasis web, penentuan <alamat IP>:<port> server SAP OData Anda bersifat opsional. Atau, tambahkan informasi ini nanti dalam spesifikasi OpenAPI yang dihasilkan atau setelah Anda mengimpor file ke API Management.

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

Impor spesifikasi OpenAPI

1. Di panel navigasi kiri, di bagian API , pilih API.

2. Di bawah Buat definisi baru, pilih OpenAPI:

   

3. Klik Pilih file, lalu pilih openapi-spec.json file 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.

Catatan

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

Menyelesaikan konfigurasi API

Tambahkan tiga operasi berikut ke API yang Anda impor:

• GET /$metadata

  Operasi	Deskripsi	Konfigurasi tambahan untuk operasi
  GET /$metadata	Memungkinkan agar API Management dapat mencapai titik akhir $metadata yang diperlukan untuk integrasi klien dengan server OData. Operasi yang diperlukan ini tidak disertakan dalam spesifikasi OpenAPI yang telah Anda buat dan impor.	Tambahkan respons 200 OK.

  

• HEAD /

  Operasi	Deskripsi
  HEAD /	Memungkinkan klien untuk bertukar token pemalsuan permintaan lintas situs (CSRF) dengan server SAP jika diperlukan. SAP juga memungkinkan pertukaran token CSRF melalui kata kerja GET. Pembahasan mengenai pertukaran token CSRF tidak dicakup dalam artikel ini. Lihat contoh cuplikan kebijakan API Management untuk memediasi pertukaran token.

  

• GET /

  Operasi	Deskripsi	Konfigurasi tambahan untuk operasi
  GET /	Mengaktifkan konfigurasi kebijakan di akar layanan.	Konfigurasikan kebijakan rewrite-uri masuk berikut untuk menambahkan garis miring tambahan ke permintaan yang diteruskan ke root dari layanan: <rewrite-uri template="/" copy-unmatched-params="true" /> Kebijakan ini menghilangkan potensi ambiguitas di antara permintaan yang menggunakan dan yang tidak menggunakan garis miring di akhir. Kedua jenis permintaan ini diperlakukan secara berbeda oleh beberapa backend.

  

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

Uji API Anda

1. Navigasi ke instans API Management Anda.

2. Di panel navigasi kiri, di bagian API , pilih 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.

Pertimbangan produksi

• 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 mengambil token X-CSRF.
• Untuk panduan tentang menyebarkan, mengelola, dan memigrasikan API dalam skala besar, lihat:
  • Penyebaran API otomatis dengan APIOps.
  • CI/CD untuk API Management menggunakan templat Azure Resource Manager.

Konten terkait

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