Importare metadati OData SAP come API

SI APPLICA A: Tutti i livelli di Gestione API

Questo articolo illustra come importare un servizio OData usando la relativa descrizione dei metadati. In questo articolo SAP Gateway Foundation funge da esempio.

Contenuto dell'articolo:

• Recuperare i metadati OData dal servizio SAP
• Importare i metadati OData in Gestione API, 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 API Management esistente. Crearne una se non è già stato fatto.

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

• Se il back-end SAP usa un certificato autofirmato (a scopo di 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 punta al servizio back-end SAP.
  3. Deselezionare Convalida catena di certificati e Convalida nome certificato.

  Nota

  Per gli scenari di produzione, usare i certificati appropriati per la verifica SSL end-to-end.

Recuperare i metadati OData dal servizio SAP

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

• Usare il client gateway SAP (/IWFND/GW_CLIENT transazione) 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 l'API in Gestione API

Scegliere uno dei metodi seguenti per importare l'API in Gestione API: importare direttamente il codice XML dei metadati come API OData o convertire il codice XML dei metadati in una specifica OpenAPI.

Metadati OData

Importare metadati OData

1. Nel menu a sinistra selezionare API >+ 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 ODataimmettere un URL per un endpoint di metadati OData, in genere l'URL della radice del servizio, accodato con /$metadata. In alternativa, selezionare un file XML OData locale da importare.

   2. Immettere le impostazioni rimanenti 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 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> propri API OData.

3. Nella scheda Set di entità e funzioni selezionare il menu di scelta rapida (...) accanto a un set di entità o a una funzione e 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> propri API OData.

2. Nella scheda Set di entità e funzioni selezionare il menu di scelta rapida (...) accanto a un set di entità o a una funzione e selezionare Test.

   

3. Nella console di test immettere i parametri del modello, i parametri di query e le intestazioni per il test e selezionare Test. Altre informazioni sul test di un'API nel portale.

Proteggere l'API OData

Proteggere l'API OData applicando sia i criteri di autenticazione e autorizzazione esistenti sia un criterio di convalida di OData per la protezione 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.

   Di seguito è riportato un comando di esempio per convertire il codice XML OData v2 per il servizio di test 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
   

   Nota

   • A scopo di test con un singolo file XML, è possibile usare un convertitore basato sul Web basato sullo 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 in Gestione API.

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

Importare e pubblicare l'API back-end

1. Nel menu di spostamento laterale, nella sezione API selezionare API.

2. In Crea una nuova definizione, selezionare Specifica OpenAPI.

   

3. Fare clic su Seleziona un file e selezionare il file openapi-spec.json salvato in locale in un passaggio precedente.

4. Immettere le impostazioni API. È possibile impostare i valori durante la creazione o configurarli successivamente passando alla scheda Impostazioni.

   • In 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

Le limitazioni relative all'importazione delle API sono documentate in un altro articolo.

Completare la configurazione dell'API

Aggiungere le tre operazioni seguenti all'API importata.

• GET /$metadata

  Operazione	Descrizione	Ulteriore configurazione 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	Ulteriore configurazione per l'operazione
  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 usando il verbo GET. Lo scambio di token CSRF non è trattato in questo articolo. Vedere un esempio di frammento di criteri di Gestione API per lo scambio di token broker.	N/D

  

• GET /

  Operazione	Descrizione	Ulteriore configurazione 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à delle richieste con o senza barre finali, che vengono trattate in modo diverso da alcuni back-end.

  

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

Testare l'API

1. Passare all'istanza di Gestione API.

2. Nel menu di spostamento laterale, nella sezione API selezionare API.

3. In 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 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, tracciare la chiamata.

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

Considerazioni sulla produzione

• Vedere uno scenario end-to-end di esempio per integrare Gestione API 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. Vedere anche frammenti di criteri per la propagazione delle entità SAP e il recupero di un token X-CSRF.
• Per indicazioni su come distribuire, gestire ed eseguire la migrazione di API su larga scala, vedere:
  • Distribuzioni di API automatizzate con APIOps
  • CI/CD per Gestione API usando i modelli di Azure Resource Manager.

Argomenti correlati

• 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 del servizio app
• 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'app per le funzioni di Azure
• Importare un'app per la logica di Azure
• Importare un servizio Service Fabric
• Importare un'API di OpenAI di Azure
• Importare un'API OData
• Importare metadati OData SAP
• Importare un'API gRPC
• Modificare un'API