SAP OData meta verilerini API olarak içeri aktarma

UYGULANANLAR: Tüm API Management katmanları

Bu makalede, meta veri açıklamasını kullanarak bir OData hizmetinin nasıl içeri aktarıldığı açıklanır. ÖRNEK olarak SAP Gateway Foundation kullanılır.

Bu makalede şunları yapacaksınız:

• SAP hizmetinizden OData meta verilerini alma
• OData meta verilerini doğrudan veya OpenAPI belirtimine dönüştürdükten sonra Azure API Management'a aktarma
• API yapılandırmasını tamamlama
• Azure portalında API’yi test etme

Önkoşullar

• Api Management örneği. Eğer bir tane yoksa, Azure portalını kullanarak bir API Yönetimi örneği oluşturun bölümündeki adımları tamamlayın.

• OData v2 veya v4 olarak kullanıma sunulan bir SAP sistemi ve hizmeti.

• SAP arka ucunuz otomatik olarak imzalanan bir sertifika kullanıyorsa (test için), SSL için güven zinciri doğrulamasını devre dışı bırakmanız gerekebilir. Bunu yapmak için API Management örneğinizde bir arka uç yapılandırın:

  1. Azure portalında, API'ler'in altında Arka Uçlar.
  2. SAP arka uç hizmetine işaret eden bir Özel URL ekleyin.
  3. Sertifika zincirini doğrula ve Sertifika adını doğrula onay kutularını temizleyin.

  Not

  Üretim senaryolarında uçtan uca SSL doğrulaması için uygun sertifikaları kullanın.

SAP hizmetinizden OData meta verilerini alma

SAP hizmetinizden meta veri XML'sini almak için aşağıdaki yöntemlerden birini kullanın. Meta veri XML'sini bir OpenAPI belirtimine dönüştürmeyi planlıyorsanız, dosyayı yerel olarak kaydedin.

• SAP Gateway İstemcisi'ni (işlem /IWFND/GW_CLIENT) kullanın.
  veya
• XML'yi almak için doğrudan bir HTTP çağrısı yapın: http://<OData server URL>:<port>/<path>/$metadata.

API Management örneğinize gidin

1. Azureportalında API Management hizmetleriniarayıp seçin:

   

2. API Management hizmetleri sayfasında API Management örneğinizi seçin:

   

API'yi API Management'a aktarma

API'nizi API Management'a aktarmak için aşağıdaki yöntemlerden birini seçin:

• Meta veri XML'sini doğrudan OData API'si olarak içeri aktarın.
• Meta veri XML'sini OpenAPI belirtimine dönüştürün.

OData meta verileri

OData meta verilerini içeri aktarma

1. Sol menüde API API'leri'ni> ve ardından + API Ekle'yi seçin.

2. Tanımdan oluştur'un altında OData'yı seçin:

   

3. API ayarlarını girin. Daha sonra API'nin Ayarlar sekmesine giderek ayarlarınızı güncelleştirebilirsiniz.

   1. OData belirtiminde, OData meta veri uç noktası için bir URL girin. Bu değer, genellikle hizmet köküne eklenen /$metadata ile URL'dir. Alternatif olarak, içeri aktaracak yerel bir OData XML dosyası seçin.

   2. API'nizi yapılandırmak için ek ayarlar girin. Bu ayarlar, İlk API'nizi içeri aktarma ve yayımlama öğreticisinde açıklanmıştır.

4. Oluştur'u belirleyin.

   API, API listesine eklenir. OData meta veri açıklamasında gösterilen varlık kümeleri ve işlevleri, API'nin Varlık kümeleri ve işlevleri sekmesinde görünür.

   

OData şemasını güncelleştirme

API'nizin OData şemasını görüntülemek için portaldaki bir düzenleyiciye erişebilirsiniz. API değişirse, API Management'taki şemayı bir dosyadan veya OData hizmet uç noktasından da güncelleştirebilirsiniz.

1. Portalda API Management örneğine gidin.

2. Sol menüde API'leri ve ardından OData API'nizi seçin.

3. Varlık kümeleri ve işlevler sekmesinde, bir varlık kümesinin veya işlevin yanındaki üç noktayı (...) ve ardından Düzenle'yi seçin.

   

4. Şemayı gözden geçirin. Güncelleştirmek istiyorsanız Dosyadan güncelleştir'i veya Uç noktadan şemayı güncelleştir'i seçin.

   

OData API'nizi test edin

1. Sol menüde API'leri ve ardından OData API'nizi seçin.

2. Varlık kümeleri ve işlevler sekmesinde, bir varlık kümesinin veya işlevin yanındaki üç noktayı (...) seçin ve ardından Test'i seçin.

   

3. Test konsolunda, testinizin şablon parametrelerini, sorgu parametrelerini ve üst bilgilerini girin ve ardından Test'i seçin. Portalda API'leri test etme hakkında daha fazla bilgi için bkz. Portalda yeni API'yi test etme.

OData API'nizin güvenliğini sağlama

OData API istekleri aracılığıyla saldırılara karşı koruma sağlamak için mevcut kimlik doğrulama ve yetkilendirme ilkelerini ve OData doğrulama ilkesini uygulayarak OData API'nizin güvenliğini sağlayın.

İpucu

Portalda, API ilkeleri sekmesinde OData API'niz için ilkeleri yapılandırın.

OpenAPI belirtimi

OData meta verilerini OpenAPI JSON'a dönüştürme

1. OData XML'sini OpenAPI JSON biçimine dönüştürün. Meta veri XML'inize bağlı olarak OData v2 veya OData v4 için bir OASIS açık kaynak aracı kullanın.

   Aşağıdaki örnek, test hizmeti epm_ref_apps_prod_man_srviçin OData v2 XML'yi dönüştürür:

   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
   

   Not

   • Tek bir XML dosyasıyla test için açık kaynak bir aracı temel alan web tabanlı bir dönüştürücü kullanabilirsiniz.
   • Araç veya web tabanlı dönüştürücü ile SAP OData sunucunuzun IP adresini<:>bağlantı noktasını< belirtmek >isteğe bağlıdır. Alternatif olarak, bu bilgileri daha sonra oluşturduğunuz OpenAPI belirtimine veya dosyayı API Management'a aktardıktan sonra ekleyin.

2. Dosyayı API Yönetimine openapi-spec.json aktarmak için yerel olarak kaydedin.

OpenAPI belirtimlerini içeri aktarma

1. Sol gezinti bölmesindeki API'ler bölümünde API'ler'i seçin.

2. Yeni tanım oluştur'un altında OpenAPI'yi seçin:

   

3. Dosya seç'e tıklayın ve önceki adımda yerel olarak kaydettiğiniz dosyayı seçinopenapi-spec.json.

4. API ayarlarını girin. Bu değerleri API'yi içeri aktarırken ayarlayabilir veya daha sonra Ayarlar sekmesine giderek yapılandırabilirsiniz.

   • API URL'sinin son eki için, geçerli SAP hizmetiyle aynı URL yolunu kullanmanızı öneririz.

   • API ayarları hakkında daha fazla bilgi için, İlk API'nizi İçe Aktarma ve Yayımlama öğreticisine bakın.

5. Oluştur'u belirleyin.

Not

API içeri aktarma sınırlamaları hakkında bilgi için bkz. API içeri aktarma kısıtlamaları ve bilinen sorunlar.

API yapılandırmasını tamamlama

İçeri aktardığınız API'ye aşağıdaki üç işlemi ekleyin:

• GET /$metadata

  Operasyon	Açıklama	İşlem için ek yapılandırma
  GET /$metadata	API Management'in, istemci entegrasyonu için gerekli olan OData sunucusunun uç noktasına $metadata erişmesini sağlar. Bu gerekli işlem, oluşturduğunuz ve içeri aktardığınız OpenAPI belirtimine dahil değildir.	Bir 200 OK yanıt ekleyin.

  

• HEAD /

  Operasyon	Açıklama
  HEAD /	İstemcinin gerektiğinde SAP sunucusuyla siteler arası istek sahteciliği (CSRF) belirteçlerini değiştirmesini sağlar. SAP ayrıca GET fiili aracılığıyla CSRF belirteci değişimine de izin verir. CSRF belirteç değişimi bu makalede ele alınmıyor. Token değişimini yönetmek için örnek bir API Management ilke parçacığına bakın.

  

• GET /

  Operasyon	Açıklama	İşlem için ek yapılandırma
  GET /	Hizmet kökünde ilke yapılandırmasını etkinleştirir.	Hizmet köküne iletilen isteklere sondaki eğik çizgiyi eklemek için aşağıdaki gelen rewrite-uri ilkesini yapılandırın: <rewrite-uri template="/" copy-unmatched-params="true" /> Bu politika, sonunda eğik çizgi bulunan veya bulunmayan istekler arasındaki olası belirsizliği kaldırır. Bu iki tür istek, bazı arka uçlar tarafından farklı şekilde değerlendirilir.

  

Ortamınız için uygun bir yöntem kullanarak arka ucunuzda kimlik doğrulamasını da yapılandırmanız gerekir. Örnekler için bkz . API Management kimlik doğrulaması ve yetkilendirme ilkeleri.

API’nizi test etme

1. API Management örneğine gidin.

2. Sol gezinti bölmesindeki API'ler bölümünde API'ler'i seçin.

3. Tüm API'ler'in altında içeri aktarılan API'nizi seçin.

4. Test konsoluna erişmek için Test sekmesini seçin.

5. Bir işlem seçin, gerekli değerleri girin ve gönder'i seçin.

   Örneğin, SAP arka sistemine bağlantıyı doğrulamak için GET /$metadata çağrıyı test edin.

6. Yanıtı görüntüleyin. Sorun gidermek için aramayı izleyin.

7. Testi tamamladığınızda test konsolundan çıkın.

Üretimle ilgili dikkat edilmesi gerekenler

• API Management'i SAP ağ geçidiyle bütünleştirmeye yönelik örnek bir uçtan uca senaryoya bakın.
• API Management ilkelerini kullanarak SAP arka ucuna erişimi denetleme. Örneğin, API bir OData API'si olarak içeri aktarıldıysa, OData isteğini doğrulama politikasını kullanın. SAP ECC veya S/4HANA ya da SAPSuccessFactors için SAP sorumlusu yayma ve bir X-CSRF belirteci getirme için ilke parçacıkları da vardır.
• API'leri büyük ölçekte dağıtma, yönetme ve geçirme konusunda rehberlik için bkz:
  • APIOps ile otomatik API dağıtımları.
  • Azure Resource Manager şablonlarını kullanarak API Yönetimi için CI/CD.

İlgili içerik

• API içeri aktarma sınırlamaları
• OpenAPI belirtimini içeri aktarma
• SOAP API’sini içeri aktarma
• SOAP API'sini içeri aktarma ve REST dönüştürme
• App Service API'sini içeri aktarma
• Kapsayıcı uygulaması API'sini içeri aktarma
• WebSocket API'lerini içeri aktarma
• GraphQL API’sini içeri aktarma
• GraphQL şemasını içeri aktarma ve alan çözümleyicilerini ayarlama
• İşlev uygulaması API'sini içeri aktarma
• Mantıksal uygulama API'sini içeri aktarma
• Service Fabric hizmetlerini içeri aktarma
• Azure AI Foundry API'lerini içeri aktarma
• Azure OpenAI API'lerini içeri aktarma
• LLM API'lerini içeri aktarma
• OData API'sini içeri aktarma
• REST API'yi MCP sunucusu olarak dışarı aktarma
• Mevcut bir MCP sunucusunu kullanıma sunma
• A2A aracı API'lerini içeri aktarma
• SAP OData meta verilerini içeri aktarma
• gRPC API'lerini içeri aktarma
• API’yi düzenleme