Importare metadati OData SAP come API

SI APPLICA A: Tutti i livelli di Gestione API

Questo articolo descrive come importare un servizio OData (Open Data Protocol) in Gestione API di Azure usando i metadati OData. L'esempio seguente usa SAP Gateway Foundation.

In questo articolo vengono illustrate le operazioni seguenti:

• Recuperare i metadati OData dal servizio SAP
• Importare i metadati OData in Gestione API di Azure, direttamente o dopo la conversione in una specifica OpenAPI
• Completare la configurazione dell'API
• Testare l'API nel portale di Azure

Prerequisiti

• Creare un'istanza di Gestione API.

• Un sistema e un servizio SAP esposti come OData v2 o v4.

• Se il back-end SAP usa un certificato autofirmato (per il test), potrebbe essere necessario disabilitare la verifica della catena di attendibilità per SSL. A tale scopo, configurare un back-end nell'istanza di Gestione API:

  1. Nel portale di Azure, in API, selezionare Back-end>.
  2. Aggiungere un URL personalizzato che punti al servizio back-end SAP.
  3. Espandere la sezione Avanzate , quindi deselezionare le caselle di controllo Convalida catena di certificati e Convalida nome certificato .

  Nota

  Negli scenari di produzione usare i certificati appropriati per la verifica SSL end-to-end.

  Suggerimento

  Per l'ambito completo della funzionalità di Gestione API, convertire l'API SAP OData in una specifica OpenAPI prima della registrazione.

Recuperare i metadati OData dal servizio SAP

Usare uno dei metodi seguenti per recuperare il codice XML dei metadati dal servizio SAP. Se si prevede di convertire il file XML di metadati in una specifica OpenAPI, salvare il file in locale.

• Usare il client gateway SAP (transazione /IWFND/GW_CLIENT).
• Effettuare una chiamata HTTP diretta per recuperare il codice XML: http://<OData server URL>:<port>/<path>/$metadata.
• Usare il SAP Business Accelerator Hub se applicabile.

Passare all'istanza di Gestione API

1. Nel portale di Azure cercare e selezionare Servizi gestione API:

   

2. Nella pagina Servizi Gestione API selezionare l'istanza di Gestione API:

   

Importare un'API in Gestione API

Scegliere uno dei metodi seguenti per importare l'API in Gestione API:

• Convertire il file XML dei metadati in una specifica OpenAPI (scelta consigliata).
• Importare direttamente il file XML dei metadati come API OData.

Specifica OpenAPI (scelta consigliata)

Convertire i metadati OData in JSON OpenAPI

1. Usare il convertitore Microsoft basato sullo strumento open source OASIS.

   Nell'esempio seguente viene convertito il codice XML OData v2 per il servizio epm_ref_apps_prod_man_srvdi test :

   oasis-converter convert epm_ref_apps_prod_man_srv.xml api.json
   

   Nota

   Per i test con un singolo file XML, è possibile usare l'esperienza basata sul Web.

2. Salvare il fileopenapi-spec.json in locale per l'importazione in Gestione API.

Importare la specifica OpenAPI

1. Nella sezione API del menu della barra laterale selezionare API.

2. Sotto Crea da definizione, seleziona il riquadro OpenAPI:

   

3. Scegliere Seleziona un file e quindi selezionare il fileopenapi-spec.json salvato in locale in un passaggio precedente.

4. Immettere le impostazioni API. È possibile impostare questi valori quando si importa l'API o configurarli in un secondo momento passando alla scheda Impostazioni .

   • Per il suffisso URL API è consigliabile usare lo stesso percorso URL del servizio SAP originale.

   • Per altre informazioni sulle impostazioni API, vedere Importare e pubblicare la prima esercitazione sull'API.

5. Fare clic su Crea.

È anche necessario configurare l'autenticazione nel back-end usando un metodo appropriato per l'ambiente in uso. Per esempi, vedere Autenticazione e autorizzazione.

Nota

Per informazioni sulle limitazioni di importazione delle API, vedere Limitazioni relative all'importazione delle API e problemi noti.

Testare l'API

1. Accedere alla tua istanza di Gestione API.

2. Nel menu della barra laterale selezionare API>API.

3. Sotto Tutte le API, selezionare l'API importata.

4. Selezionare la scheda Test per accedere alla console di test.

5. Selezionare un'operazione, immettere i valori necessari e quindi selezionare Invia.

   Ad esempio, testare la chiamata GET /$metadata per verificare la connettività al back end SAP.

6. Visualizzare la risposta. Per risolvere i problemi, traccia la chiamata.

7. Al termine dei test, uscire dalla console di test.

Metadati OData

Importare metadati OData

1. Nel menu della barra laterale selezionare API> e quindi + Aggiungi API.

2. In Crea da definizione selezionare il riquadro OData :

   

3. Immettere le impostazioni API. È possibile aggiornare le impostazioni in un secondo momento passando alla scheda Impostazioni dell'API.

   1. In Specifica OData immettere un URL per un endpoint di metadati OData. Questo valore è in genere l'URL della radice del servizio, aggiunto con /$metadata. In alternativa, selezionare un file XML OData locale da importare.

   2. Immettere impostazioni aggiuntive per configurare l'API. Queste impostazioni sono illustrate nell'esercitazione Importare e pubblicare la prima API.

4. Fare clic su Crea.

   L'API viene aggiunta all'elenco di API. I set di entità e le funzioni esposti nella descrizione dei metadati OData vengono visualizzati nella scheda Set di entità e funzioni dell'API.

   

Aggiornare lo schema OData

È possibile accedere a un editor nel portale per visualizzare lo schema OData dell'API. Se l'API cambia, è anche possibile aggiornare lo schema in Gestione API da un file o da un endpoint di servizio OData.

1. Nel menu della barra laterale, API> e quindi selezionare l'API OData.

2. Nella scheda Set di entità e funzioni selezionare i puntini di sospensione (...) accanto a un set di entità o a una funzione e quindi selezionare Modifica.

   

3. Esaminare lo schema. Per aggiornarlo, selezionare Aggiorna dal file o Aggiorna schema dall'endpoint.

   

Testare l'API OData

1. Nel menu della barra laterale, API> e quindi selezionare l'API OData.

2. Nella scheda Set di entità e funzioni selezionare i puntini di sospensione (...) accanto a un set di entità o a una funzione e quindi selezionare Test.

   

3. Nella console di test immettere i parametri del modello, i parametri di query e le intestazioni per il test e quindi selezionare Test. Per altre informazioni sui test delle API nel portale, vedere Testare la nuova API nel portale.

Proteggere l'API OData

Proteggere l'API OData applicando criteri di autenticazione e autorizzazione esistenti e criteri di convalida OData per proteggersi da attacchi tramite richieste API OData.

Suggerimento

Nel portale configurare i criteri per l'API OData nella scheda criteri API.

Considerazioni sulla produzione

• Usare Defender per le API per la protezione completa del ciclo di vita, il rilevamento e la copertura delle risposte per le API.
• Consulta un esempio di scenario end-to-end per l'integrazione di API Management con un gateway SAP.
• Controllare l'accesso a un back-end SAP usando i criteri di Gestione API. Ad esempio, se l'API viene importata come API OData, usare il criterio convalida richiesta OData. Sono presenti anche frammenti di codice per criteri per la propagazione di identità SAP per SAP ECC o S/4HANA o per SAP SuccessFactors e per recuperare un token X-CSRF.
• Per indicazioni sulla distribuzione, la gestione e la migrazione di API su larga scala, vedere:
  • Distribuzioni automatizzate di API con APIOps
  • Usare DevOps e CI/CD per pubblicare API

Contenuto correlato

• Limitazioni relative all'importazione di API
• Importare una specifica OpenAPI
• Importare un'API SOAP
• Importare un'API SOAP e convertirla in REST
• Importare un'API dell'App Service
• Importare un'API dell'app contenitore
• Importare un'API WebSocket
• Importare un'API GraphQL
• Importare uno schema di GraphQL e configurare resolver di campo
• Importare un’API dell'app per le funzioni
• Importare un'API per un'app di logica
• Importare un servizio Service Fabric
• Importare un'API Microsoft Foundry
• Importare un'API OpenAI Azure
• Importare un'API LLM
• Importare un'API OData
• Esportare un'API REST come server MCP
• Rendere visibile un server MCP esistente
• Importare un'API dell'agente A2A
• Importare metadati OData SAP
• Importare un'API gRPC
• Modificare un'API