Condividi tramite


Aggiungere manualmente un'API

SI APPLICA A: tutti i livelli di Gestione API

Questo articolo illustra come aggiungere manualmente un'API a Gestione API di Azure. Quando si vogliono creare risposte fittizie dall'API, è possibile creare un'API vuota. Per informazioni sulla creazione di risposte API fittizie, vedere Simulare le risposte dell'API.

Per importare un'API esistente, vedere la sezione Contenuto correlato di questo articolo.

Questo articolo illustra come creare un'API vuota. Si specificheranno httpbin.org (un servizio di test pubblico) come API back-end.

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.

Creare un'API

  1. In API nel menu a sinistra selezionare API.

  2. Selezionare + Aggiungi API.

  3. Selezionare il riquadro HTTP :

    Screenshot che mostra il riquadro HTTP nel portale di Azure.

  4. Immettere l'URL del servizio Web back-end (ad esempio, https://httpbin.org) e altre impostazioni per l'API. Le impostazioni sono illustrate nell'esercitazione Importare e pubblicare la prima API.

  5. Selezionare Crea.

A questo punto, non si hanno operazioni in Gestione API di cui viene eseguito il mapping alle operazioni nell'API back-end. Se si chiama un'operazione esposta tramite il back-end ma non tramite Gestione API, viene visualizzato un errore 404.

Note

Per impostazione predefinita, quando si aggiunge un'API, anche se è connessa a un servizio back-end, Gestione API non esporrà alcuna operazione finché non vengono consentite. Per consentire un'operazione del servizio back-end, creare un'operazione di Gestione API mappata all'operazione back-end.

Aggiungere e testare un'operazione

Questa sezione illustra come aggiungere un'operazione /get per eseguirne il mapping all'operazione back-end http://httpbin.org/get.

Aggiungere un'operazione

  1. Selezionare l'API creata nel passaggio precedente.
  2. Selezionare + Aggiungi operazione.
  3. In URL selezionare GET e immettere /get nella casella di testo.
  4. In Nome visualizzato immettere FetchData.
  5. Selezionare Salva.

Testare l'operazione

Testare l'operazione nel portale di Azure. È anche possibile testarlo nel portale per sviluppatori.

  1. Selezionare la scheda Test.
  2. Selezionare FetchData.
  3. Seleziona Invia.

La risposta generata dall'operazione http://httpbin.org/get viene visualizzata nella sezione relativa alla risposta HTTP . Per trasformare le operazioni, vedere Trasformare e proteggere l'API.

Aggiungere e testare un'operazione con parametri

Questa sezione illustra come aggiungere un'operazione che accetta un parametro. In questo esempio, si mappa l'operazione su http://httpbin.org/status/200.

Aggiungere un'operazione

  1. Selezionare l'API creata in precedenza.
  2. Nella scheda Progettazione selezionare + Aggiungi operazione.
  3. In URL selezionare GET e immettere /status/{code} nella casella di testo.
  4. In Nome visualizzato immettere GetStatus.
  5. Selezionare Salva.

Testare l'operazione

Testare l'operazione nel portale di Azure. È anche possibile testarlo nel portale per sviluppatori.

  1. Selezionare la scheda Test.

  2. Selezionare GetStatus. Nel codice immettere 200.

  3. Seleziona Invia.

    La risposta generata dall'operazione http://httpbin.org/status/200 viene visualizzata nella sezione relativa alla risposta HTTP . Per trasformare le operazioni, vedere Trasformare e proteggere l'API.

Aggiungere e testare un'operazione con caratteri jolly

Questa sezione illustra come aggiungere un'operazione con caratteri jolly. Un'operazione wildcard permette di trasmettere un valore arbitrario con una richiesta API. Anziché creare operazioni GET separate, come illustrato nelle sezioni precedenti, è possibile creare un'operazione GET con caratteri jolly.

Attenzione

Prestare attenzione quando si configura un'operazione wildcard. Questa configurazione potrebbe rendere un'API più vulnerabile a determinate minacce per la sicurezza delle API.

Aggiungere un'operazione

  1. Selezionare l'API creata in precedenza.
  2. Nella scheda Progettazione selezionare + Aggiungi operazione.
  3. In URL selezionare GET e immettere /* nella casella di testo.
  4. In Nome visualizzato immettere WildcardGet.
  5. Selezionare Salva.

Testare l'operazione

Testare l'operazione nel portale di Azure. È anche possibile testarlo nel portale per sviluppatori.

  1. Selezionare la scheda Test.

  2. Selezionare WildcardGet. Provare le operazioni GET testate nelle sezioni precedenti o un'altra operazione GET supportata.

    Ad esempio, in Parametri modello, modificare il valore accanto al nome del carattere jolly (*) in intestazioni. L'operazione restituisce le intestazioni HTTP della richiesta in ingresso.

  3. Seleziona Invia.

    La risposta generata dall'operazione http://httpbin.org/headers viene visualizzata nella sezione relativa alla risposta HTTP . Per trasformare le operazioni, vedere Trasformare e proteggere l'API.

Note

Può essere importante comprendere come l'host per l'API back-end con il quale si sta integrando gestisce le barre finali in un URL dell'operazione. Per ulteriori informazioni, consultare le domande frequenti su Gestione 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 per la logica di Azure
  • Azure Service Fabric

Note

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.