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ılacağını gösterir. Bu makalede SAP Gateway Foundation örnek olarak görev alır.

Bu makalede şunları yapacaksınız:

• SAP hizmetinizden OData meta verilerini alma
• OData meta verilerini DOĞRUDAN veya OpenAPI belirtimine dönüştürmeden sonra API Management'a aktarma
• API yapılandırmasını tamamlama
• Azure portalında API’yi test etme

Önkoşullar

• Mevcut bir API Management örneği. Henüz oluşturmadıysanız bir tane oluşturun.

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

• SAP arka ucunuz otomatik olarak imzalanan bir sertifika kullanıyorsa (test amacıyla), 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>+ Ekle'yi seçin.
  2. SAP arka uç hizmetine işaret eden bir Özel URL ekleyin.
  3. Sertifika zincirini doğrula ve Sertifika adını doğrula'nın işaretini kaldırın.

  Not

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

SAP hizmetinizden OData meta verilerini alma

Aşağıdaki yöntemlerden birini kullanarak SAP hizmetinizden meta veri XML'sini alı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) 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. Azure portalında API Management hizmetlerini arayın ve 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 veya 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'ler>+ 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, bir OData meta veri uç noktasının URL'sini girin( genellikle ile ekli hizmet kökü URL'si)./$metadata Alternatif olarak, içeri aktaracak yerel bir OData XML dosyası seçin.

   2. API'nizi yapılandırmak için kalan 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üdeN OData API'nizin API'lerini> seçin.

3. Varlık kümeleri ve işlevler sekmesinde, bir varlık kümesinin veya işlevin yanındaki bağlam menüsünü (...) 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üdeN OData API'nizin API'lerini> seçin.

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

   

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

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

OData API istekleri aracılığıyla saldırılara karşı koruma sağlamak için hem mevcut kimlik doğrulama hem de 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ğıda, test hizmeti epm_ref_apps_prod_man_srviçin OData v2 XML'yi dönüştürmeye yönelik örnek bir komut verilmiştir:

   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 amacıyla, açık kaynak aracına dayalı 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 API Management'a aktardıktan sonra ekleyin.

2. DOSYAYı API Management'a openapi-spec.json aktarmak için yerel olarak kaydedin.

Arka uç API'lerini içeri aktarma ve yayımlama

1. Yan gezinti menüsünde, API'ler bölümünün altında API'ler'i seçin.

2. Yeni tanım oluştur'un altında OpenAPI belirtimi'ni 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. Oluşturma sırasında değerleri ayarlayabilir veya daha sonra Ayarlar sekmesine giderek bunları yapılandırabilirsiniz.

   • API URL son ekinde, özgün SAP hizmetinde olduğu gibi aynı URL yolunu kullanmanızı öneririz.

   • API ayarları hakkında daha fazla bilgi için bkz . İlk API öğreticinizi içeri aktarma ve yayımlama.

5. Oluştur'u belirleyin.

Not

API içeri aktarma sınırlamaları başka bir makalede belgelenmiştir.

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 daha fazla yapılandırma
  GET /$metadata	API Management'ın OData sunucusuyla istemci tümleştirmesi için gerekli olan uç noktaya ulaşmasını $metadata sağlar. Bu gerekli işlem, oluşturduğunuz ve içeri aktardığınız OpenAPI belirtimine dahil değildir.	Yanıt 200 OK ekleyin.

  

• HEAD /

  Operasyon	Açıklama	İşlem için daha fazla yapılandırma
  HEAD /	İstemcinin gerektiğinde SAP sunucusuyla Siteler Arası İstek Sahteciliği (CSRF) belirteçlerini değiştirmesini sağlar. SAP ayrıca GET fiilini kullanarak CSRF belirteç değişimine de izin verir. CSRF belirteç değişimi bu makalede ele alınmıyor. Aracı belirteci değişimine yönelik örnek bir API Management ilke parçacığına bakın.	Yok

  

• GET /

  Operasyon	Açıklama	İşlem için daha fazla 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 ilke, bazı arka uçlar tarafından farklı şekilde ele alınan, sonunda eğik çizgi olan veya olmayan isteklerin olası belirsizliğini kaldırır.

  

Ayrıca ortamınız için uygun bir yöntem kullanarak arka ucunuzda kimlik doğrulamasını yapılandırın. Örnekler için bkz . API Management kimlik doğrulaması ve yetkilendirme ilkeleri.

API’nizi test etme

1. API Management örneğine gidin.

2. Yan gezinti menüsünde, API'ler bölümünün altında 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 ucuna bağlantıyı doğrulamak için çağrıyı test GET /$metadata edin

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

7. Test tamamlandığında test konsolundan çıkın.

Üretimle ilgili dikkat edilmesi gerekenler

• API Management'ı sap ağ geçidiyle tümleştirmek için ö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ği doğrulama ilkesini kullanın. Ayrıca bkz. SAP sorumlusu yayma ve X-CSRF belirtecini getirme için ilke parçacıkları.
• API'leri büyük ölçekte dağıtma, yönetme ve geçirme yönergeleri için bkz:
  • APIOps ile otomatik API dağıtımları
  • Azure Resource Manager şablonlarını kullanarak API Management için CI/CD.

İlgili konular

• 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’e dönüştürme
• App Service API'sini içeri aktarma
• Kapsayıcı Uygulama 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
• Azure İşlev Uygulamalarını içeri aktarma
• Azure Mantıksal Uygulamalarını içeri aktarma
• Service Fabric hizmetlerini içeri aktarma
• Azure OpenAI API'lerini içeri aktarma
• OData API'sini içeri aktarma
• SAP OData meta verilerini içeri aktarma
• gRPC API'lerini içeri aktarma
• API’yi düzenleme