Condividi tramite

Importare un'API OData

  • Articolo

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.

    Selezionare Servizi Gestione API

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

    Selezionare l'istanza di Gestione API

Importare metadati OData

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

    Screenshot di set di entità e funzioni di OData nel portale.

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.

    Screenshot del menu di scelta rapida per un set di entità di OData nel portale.

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

    Screenshot dell'editor dello schema per l'API OData nel portale.

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.

    Screenshot dell'opzione Test nel menu di scelta rapida per un set di entità di OData nel portale.

  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.

Aggiungere altre API

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

  • Una specifica OpenAPI
  • Un'API SOAP
  • Un'API GraphQL
  • Un'app Web ospitata nel servizio app di Azure
  • App per le funzioni di Azure
  • App per la logica di azure
  • Azure Service Fabric

Per aggiungere un'API diversa all'API esistente, seguire questa procedura.

Nota

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

  1. Vai alla tua istanza di Gestione API di Azure nel portale di Azure.

    Passare all'istanza di Gestione API di Azure

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

    Seleziona API

  3. Fare clic su ... accanto all'API a cui si vuole aggiungere un'altra API.

  4. Nel menu a discesa selezionare Importa.

    Selezionare Importa

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

    Selezionare un servizio