Condividi tramite


Importare un'API OData

SI APPLICA A: Tutti i livelli di Gestione API

Questo articolo illustra come importare un servizio conforme a OData come API in Gestione API.

In questo articolo vengono illustrate le operazioni seguenti:

  • Importare una descrizione dei metadati OData usando il portale di Azure
  • Gestire lo schema OData nel portale
  • Sicurezza dell'API OData

Prerequisiti

Passare all'istanza di Gestione API

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

    Screenshot che mostra i servizi gestione API nei risultati della ricerca.

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

    Screenshot che mostra un'istanza di Gestione API nella pagina Servizi Gestione API.

Importare metadati OData

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

  2. In Crea da definizione selezionare OData:

    Screenshot della creazione di un'API da una descrizione OData nel portale.

  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.

    Screenshot che mostra le funzioni e i set di entità OData.

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.

    Screenshot che mostra il percorso del comando Modifica.

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

    Screenshot dell'editor dello schema per un'API OData.

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.

    Screenshot che mostra il comando 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.

Aggiungere altre API

È possibile comporre un'API fuori dalle API esposte da servizi diversi, tra cui:

  • Una specifica OpenAPI
  • Un'API SOAP
  • Un’API GraphQL
  • Un'app Web ospitata nel servizio app di Azure
  • Funzioni di Azure
  • App logiche di Azure
  • Azure Service Fabric

Nota

Quando si importa un'API, le operazioni vengono aggiunte all'API corrente.

Per aggiungere un'API a un'API esistente:

  1. Passare all'istanza di Gestione API di Azure nel portale di Azure:

    Screenshot che mostra la pagina Dei servizi gestione API.

  2. Selezionare API nella pagina Panoramica o selezionare API>nel menu a sinistra.

    Screenshot che mostra la selezione delle API nella pagina Panoramica.

  3. Selezionare i puntini di sospensione (...) accanto all'API a cui si vuole aggiungere un'altra API.

  4. Selezionare Importa dal menu a discesa:

    Screenshot che mostra il comando Import.

  5. Selezionare un servizio da cui importare un'API.