Importare metadati OData SAP come API

SI APPLICA A: Tutti i livelli di Gestione API

Questo articolo descrive come importare un servizio OData usando la relativa descrizione dei metadati. SAP Gateway Foundation viene usato come esempio.

In questo articolo si apprenderà come:

• 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

• Un'istanza di Gestione API. Se non è disponibile, completare la procedura descritta in Creare un'istanza di Gestione API usando il portale di Azure.

• 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 >+ Aggiungi.
  2. Aggiungere un URL personalizzato che punti al servizio back-end SAP.
  3. 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.

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).
  o
• Effettuare una chiamata HTTP diretta per recuperare il codice XML: http://<OData server URL>:<port>/<path>/$metadata.

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:

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

Metadati OData

Importare metadati OData

1. Nel menu a sinistra selezionare API> e quindi + Aggiungi API.

2. In Crea da definizione selezionare 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. Seleziona 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 portale, passare all'istanza di Gestione API.

2. Nel menu a sinistra selezionare API e quindi selezionare l'API OData.

3. 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.

   

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

   

Testare l'API OData

1. Nel menu a sinistra selezionare 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.

Specifica OpenAPI

Convertire i metadati OData in JSON OpenAPI

1. Convertire il codice XML OData in formato JSON OpenAPI. Usare uno strumento open source OASIS per OData v2 o OData v4, a seconda del codice XML dei metadati.

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

   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
   

   Nota

   • Per i test con un singolo file XML, è possibile usare un convertitore basato sul Web basato su uno strumento open source.
   • Con lo strumento o il convertitore basato sul Web, specificare l'<indirizzo IP>: <porta> del server SAP OData è facoltativo. In alternativa, aggiungere queste informazioni in un secondo momento nella specifica OpenAPI generata o dopo l'importazione del file in Gestione API.

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

Importare la specifica OpenAPI

1. Nella sezione API del riquadro di spostamento a sinistra selezionare API.

2. In Crea una nuova definizione selezionare OpenAPI:

   

3. Fare clic su Seleziona un file e quindi selezionare il openapi-spec.json file 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. Seleziona Crea.

Nota

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

Completare la configurazione dell'API

Aggiungere le tre operazioni seguenti all'API importata:

• GET /$metadata

  Operazione	Descrizione	Configurazione aggiuntiva per l'operazione
  GET /$metadata	Consente a Gestione API di raggiungere l'endpoint $metadata, necessario per l'integrazione client con il server OData. Questa operazione necessaria non è inclusa nella specifica OpenAPI generata e importata.	Aggiungere una risposta 200 OK.

  

• HEAD /

  Operazione	Descrizione
  HEAD /	Consente al client di scambiare token CSRF (cross site request forgery) con il server SAP, se necessario. SAP consente anche lo scambio di token CSRF tramite il verbo GET. Lo scambio di token CSRF non è trattato in questo articolo. Vedere un esempio di frammento di criteri per la gestione delle API per mediare lo scambio di token.

  

• GET /

  Operazione	Descrizione	Configurazione aggiuntiva per l'operazione
  GET /	Abilita la configurazione dei criteri nella radice del servizio.	Configurare i criteri di riscrittura-uri seguenti per aggiungere una barra finale alle richieste inoltrate alla radice del servizio: <rewrite-uri template="/" copy-unmatched-params="true" /> Questo criterio elimina potenziali ambiguità tra le richieste con e senza barre finali. Questi due tipi di richieste vengono trattati in modo diverso da alcuni back-end.

  

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

Testare l'API

1. Accedere alla tua istanza di Gestione API.

2. Nella sezione API del riquadro di spostamento a sinistra selezionare 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.

Considerazioni sulla produzione

• 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 disponibili anche frammenti di criteri per la propagazione principale SAP per SAP ECC o S/4HANA o SAP SuccessFactors e il recupero di 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.
  • CI/CD per Gestione API usando i modelli di Azure Resource Manager.

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 della Function App
• Importare un'API per un'app di logica
• Importare un servizio Service Fabric
• Importare un'API Foundry per intelligenza artificiale di Azure
• Importare un'API di OpenAI di Azure
• Importare un'API LLM
• Importare un'API OData
• Importare metadati OData SAP
• Importare un'API gRPC
• Modificare un'API