Mengimpor metadata OData SAP sebagai API

BERLAKU UNTUK: Semua tingkatAN API Management

Artikel ini menunjukkan cara mengimpor layanan OData dengan menggunakan deskripsi metadatanya. Dalam artikel ini, SAP Gateway Foundation berfungsi sebagai contoh.

Dalam artikel ini, Anda akan:

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

Catatan

Mengimpor API OData ke API Management dari deskripsi metadatanya dalam pratinjau. Pelajari selengkapnya.

Prasyarat

• Instans API Management yang ada. Buat jika Anda belum melakukannya.

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

• Jika backend SAP Anda menggunakan sertifikat yang ditandatangani sendiri (untuk tujuan pengujian), Anda mungkin perlu menonaktifkan verifikasi rantai kepercayaan 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. Batalkan pemilihan pengaturan Validasi rantai sertifikat dan Validasi nama sertifikat.

  Catatan

  Untuk skenario produksi, gunakan sertifikat yang tepat untuk verifikasi SSL ujung-ke-ujung.

Mengambil metadata OData dari layanan SAP Anda

Ambil XML metadata dari layanan SAP Anda, menggunakan salah satu metode berikut. 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

Membuka instans API Management Anda

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

   

2. Di 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, atau konversi XML metadata ke spesifikasi OpenAPI.

Metadata OData

Mengimpor metadata OData

1. Di menu sebelah kiri, pilih API>+ 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, biasanya URL ke akar layanan, ditambahkan dengan /$metadata. Atau, pilih file XML OData lokal untuk diimpor.

   2. Masukkan pengaturan yang tersisa 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> API OData Anda.

3. Pada tab Kumpulan entitas dan fungsi , pilih menu konteks (...) di samping kumpulan entitas atau fungsi, dan 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> API OData Anda.

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

   

3. Di konsol pengujian, masukkan parameter templat, parameter kueri, dan header untuk pengujian Anda, dan pilih Uji. Pelajari selengkapnya tentang menguji API 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.

Tip

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.

   Berikut ini adalah contoh perintah untuk mengonversi XML OData v2 untuk layanan pengujian epm_ref_apps_prod_man_srv:

   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 tujuan pengujian dengan satu file XML, gunakan pengonversi berbasis web yang didasarkan pada alat sumber terbuka.
   • Dengan alat atau pengonversi berbasis web, menentukan <alamat IP>:<port> server OData sap Anda bersifat opsional. Atau, tambahkan informasi ini nanti dalam spesifikasi OpenAPI yang telah Anda buat atau setelah mengimpor ke API Management.

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

Mengimpor dan menerbitkan API backend

1. Dari menu navigasi samping, di bagian API, pilih API.

2. Di bagian Buat definisi baru, pilih spesifikasi OpenAPI.

   

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

4. Masukkan pengaturan API. Anda dapat mengatur nilai selama pembuatan atau mengonfigurasikannya nanti dengan masuk ke tab Pengaturan.

   • Dalam akhiran URL API, sebaiknya gunakan jalur URL yang sama seperti di layanan SAP asli.

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

5. Pilih Buat.

Catatan

Batasan impor API didokumentasikan di artikel lain.

Menyelesaikan konfigurasi API

Tambahkan tiga operasi berikut ke API yang telah Anda impor.

• GET /$metadata

  Operasi	Deskripsi	Konfigurasi untuk operasi lebih lanjut
  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	Konfigurasi untuk operasi lebih lanjut
  HEAD /	Memungkinkan agar klien dapat bertukar token Cross Site Request Forgery (CSRF) dengan server SAPsaat diperlukan. SAP juga memungkinkan agar pertukaran token CSRF menggunakan kata kerja GET. Pembahasan mengenai pertukaran token CSRF ada dalam artikel ini. Lihat contoh cuplikan kebijakan API Management ke pertukaran token broker.	T/A

  

• GET /

  Operasi	Deskripsi	Konfigurasi untuk operasi lebih lanjut
  GET /	Mengaktifkan konfigurasi kebijakan di akar layanan.	Konfigurasikan kebijakan penulisan ulang-uri masuk berikut untuk menambahkan garis miring berikutnya ke permintaan yang diteruskan ke akar layanan: <rewrite-uri template="/" copy-unmatched-params="true" /> Kebijakan ini menghapus potensi ambiguitas permintaan dengan atau tanpa garis miring berikutnya yang diperlakukan secara berbeda oleh beberapa backend.

  

Selain itu, konfigurasikan 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. Dari menu navigasi samping, 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, dan pilih Kirim.

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

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

7. Ketika pengujian selesai, keluar dari konsol pengujian.

Pertimbangan produksi

• Lihat contoh skenario ujung-ke-ujung untuk mengintegrasikan API Management dengan gateway SAP.
• Kontrol akses ke backend SAP menggunakan kebijakan API Management. Misalnya, jika API diimpor sebagai API OData, gunakan kebijakan validasi permintaan OData. Lihat juga cuplikan kebijakan untuk penyebaran utama SAP dan mengambil token X-CSRF.
• Untuk panduan untuk menyebarkan, mengelola, dan memigrasikan API dalam skala besar, lihat:
  • Penyebaran API otomatis menggunakan APIOps
  • CI/CD untuk API Management menggunakan templat Azure Resource Manager.

Topik terkait

• Batasan impor API
• Mengimpor spesifikasi OpenAPI
• Mengimpor API SOAP
• Mengimpor SOAP API dan mengonversi ke REST
• Impor API App Service
• Impor API Aplikasi Kontainer
• Mengimpor API WebSocket
• Mengimpor API GraphQL
• Mengimpor skema GraphQL dan menyiapkan penyelesai bidang
• Impor Aplikasi Fungsi Azure
• Impor Azure Logic App
• Impor layanan Service Fabric
• Mengimpor API OData
• Mengimpor metadata SAP OData
• Mengimpor API gRPC
• Edit API