Condividi tramite


Importare una specifica OpenAPI

SI APPLICA A: Tutti i livelli di Gestione API

Questo articolo illustra come importare un'API back-end "Specifica OpenAPI" che risiede in https://conferenceapi.azurewebsites.net?format=json. Questa API back-end è fornita da Microsoft e ospitata in Azure. e come testare l'API di Gestione API.

In questo articolo vengono illustrate le operazioni seguenti:

  • Importare una specifica OpenAPI usando il portale di Azure, l’interfaccia della riga di comando di Azure o Azure PowerShell
  • Testare l'API nel portale di Azure

Nota

Le limitazioni relative all'importazione delle API sono documentate in Restrizioni di importazione API e problemi noti.

Prerequisiti

Importare un'API back-end

  1. Nel portale di Azure accedere all'istanza di Gestione API.

  2. Nel menu a sinistra selezionare API >+ Aggiungi API.

  3. In Crea da definizione selezionare OpenAPI.

    Screenshot della creazione di un'API da una specifica OpenAPI nel portale.

  4. Immettere le impostazioni API. È possibile impostare i valori durante la creazione o configurarli successivamente passando alla scheda Impostazioni. Le impostazioni sono illustrate nell'esercitazione Importare e pubblicare la prima API.

  5. Seleziona Crea.

Testare la nuova API nel portale

È possibile chiamare le operazioni direttamente dal portale, il che consente agli amministratori di visualizzare e testare facilmente le operazioni di un'API.

  1. Selezionare l'API creata nel passaggio precedente.

  2. Selezionare la scheda Test.

  3. Selezionare un'operazione. La pagina visualizza campi per le intestazioni e campi per i parametri di query.

    Nota

    Nella console di test, Gestione API popola automaticamente un'intestazione Ocp-Apim-Subscription-Key e configura la chiave di sottoscrizione della sottoscrizione all-access integrata. Questa chiave consente l'accesso a ogni API nell'istanza di Gestione API. Facoltativamente, visualizzare l'intestazione Ocp-Apim-Subscription-Key selezionando l'icona "occhio" accanto alla richiesta HTTP.

  4. A seconda dell'operazione, immettere i valori dei parametri di query, i valori di intestazione o il corpo della richiesta. Selezionare Invia.

    Quando il test ha esito positivo, il back-end risponde con un codice di risposta HTTP corretto e alcuni dati.

    Suggerimento

    Per impostazione predefinita, la console di test invia una richiesta al proxy CORS di Gestione API, che inoltra la richiesta all'istanza di Gestione API, che a sua volta la inoltra al back-end. Questo proxy usa l'indirizzo IP pubblico 13.91.254.72 e può raggiungere solo gli endpoint pubblici. Per inviare una richiesta direttamente dal browser al servizio Gestione API, selezionare Ignora proxy CORS. Questa opzione è utile quando si vuole usare la console di test e il gateway di Gestione API è isolato dalla rete o non consente il traffico dal proxy CORS.

Per eseguire il debug di un’API, vedere Esercitazione: Eseguire il debug delle API usando la traccia delle richieste.

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

Eseguire la convalida secondo una specifica OpenAPI

È possibile configurare i criteri di convalida di Gestione API per convalidare le richieste e le risposte (o i relativi elementi) sullo schema in una specifica OpenAPI. Ad esempio, usare i criteri validate-content per convalidare le dimensioni o il contenuto di una richiesta o del corpo della risposta.

Passaggi successivi