Abilitare CORS per la console interattiva nel portale per sviluppatori di Gestione API

SI APPLICA A: Sviluppatore | Basic | Basic v2 | Standard | Standard v2 | Premium | Premium v2

La condivisione di risorse tra le origini (CORS) è un meccanismo basato su intestazione HTTP che consente a un server di indicare qualsiasi origine (dominio, schema o porta) diversa da quella da cui un browser deve consentire il caricamento delle risorse.

Per consentire ai visitatori del portale per sviluppatori di Gestione API di usare la console di test interattiva nelle pagine di riferimento api, abilitare un criterio CORS per le API nell'istanza di Gestione API. Se il nome di dominio del portale per sviluppatori non è un'origine consentita per le richieste api tra domini, gli utenti della console di test visualizzeranno un errore CORS.

Per determinati scenari, è possibile configurare il portale per sviluppatori come proxy CORS anziché abilitare un criterio CORS per le API.

Prerequisiti

• Completare la guida introduttiva seguente: Creare un'istanza di Gestione API di Azure

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:

   

Abilitare i criteri CORS per le API

È possibile abilitare un'impostazione per configurare automaticamente un criterio CORS per tutte le API nell'istanza di Gestione API. È anche possibile configurare manualmente un criterio CORS.

Annotazioni

Viene eseguita una sola politica CORS. Se si specificano più criteri CORS (ad esempio, a livello di API e a livello di tutte le API), la console interattiva potrebbe non funzionare come previsto.

Abilitare automaticamente i criteri CORS

1. Nel menu a sinistra dell'istanza di Gestione API, in Portale per sviluppatoriselezionare Panoramica del portale.
2. In Abilita CORS viene visualizzato lo stato della configurazione dei criteri CORS. Una casella di avviso indica un criterio assente o non configurato correttamente.
3. Per abilitare CORS dal portale per sviluppatori per tutte le API, selezionare Abilita CORS.

Abilitare i criteri CORS manualmente

1. Selezionare il collegamento Applica manualmente al livello globale per visualizzare il codice dei criteri generato.
2. Passare a Tutte le API nella sezione API dell'istanza di Gestione API.
3. Selezionare l'icona< />nella sezione Elaborazione in ingresso.
4. Nell'editor dei criteri inserire i criteri nella <sezione in ingresso> del file XML. Assicurarsi che il <valore di origine> corrisponda al dominio del portale per sviluppatori.

Annotazioni

Se si applicano i criteri CORS nell'ambito prodotto, anziché nell'ambito delle API e l'API usa l'autenticazione della chiave di sottoscrizione tramite un'intestazione, la console non funzionerà.

Il browser invia automaticamente una OPTIONS richiesta HTTP, che non contiene un'intestazione con la chiave di sottoscrizione. A causa della chiave di sottoscrizione mancante, Gestione API non può associare la OPTIONS chiamata a un prodotto, quindi non può applicare i criteri CORS.

Come soluzione alternativa, è possibile passare la chiave di sottoscrizione in un parametro di query.

Configurazione CORS per il nome di dominio personalizzato

Se si configura un dominio personalizzato per il portale per sviluppatori e si vuole che i visitatori usino la console di test nelle pagine di riferimento dell'API, assicurarsi di abilitare CORS per il nome di dominio del portale per sviluppatori personalizzato.

Quando si configura il dominio personalizzato, è possibile abilitare un'impostazione per aggiungere un'origine per il dominio del portale per sviluppatori personalizzato nei criteri CORS. Se CORS è già stato abilitato per il dominio predefinito, entrambe le origini verranno incluse nei criteri CORS. È possibile modificare le impostazioni dei criteri CORS in qualsiasi momento.

Opzione proxy CORS

Per alcuni scenari( ad esempio, se il gateway di Gestione API è isolato dalla rete), è possibile scegliere di configurare il portale per sviluppatori come proxy CORS stesso, anziché abilitare un criterio CORS per le API. Il proxy CORS instrada le chiamate API della console interattiva attraverso il back-end del portale nell'istanza di Gestione API.

Annotazioni

Se le API vengono esposte tramite un gateway self-hosted o il servizio si trova in una rete virtuale, è necessaria la connettività dal servizio back-end del portale per sviluppatori di Gestione API al gateway.

Per configurare il proxy CORS, accedere al portale per sviluppatori come amministratore:

1. Nella pagina Panoramica dell'istanza di Gestione API selezionare Portale per sviluppatori. Il portale per sviluppatori viene aperto in una nuova scheda del browser.
2. Nel menu a sinistra dell'interfaccia amministrativa selezionare Pagine>API>Dettagli.
3. Nella pagina API: Dettagli selezionare il widget Operazione: Dettagli e selezionare Modifica widget.
4. Selezionare Usa proxy CORS.
5. Salvare le modifiche nel portale e ripubblicare il portale.

Configurazione CORS per il portale per sviluppatori autogestito

Se si ospita automaticamente il portale per sviluppatori, è necessaria la configurazione seguente per abilitare CORS:

• Specificare l'endpoint back-end del portale usando l'opzione backendUrl nei file di configurazione. Altrimenti, il portale self-hosted non è a conoscenza della posizione del servizio backend.

• Aggiungere valori di dominio di origine alla configurazione del portale self-hosted specificando gli ambienti in cui è ospitato il portale self-hosted. Ulteriori informazioni

Contenuti correlati

• Per altre informazioni sulla configurazione di un criterio, vedere Impostare o modificare i criteri.
• Per informazioni dettagliate sui criteri CORS, vedere il riferimento sui criteri CORS.