Eseguire la migrazione al nuovo portale per sviluppatori

  • Articolo

Questo articolo descrive i passaggi da eseguire per eseguire la migrazione dal portale legacy deprecato al nuovo portale per sviluppatori in Gestione API.

Importante

Il portale per sviluppatori legacy è ora deprecato e riceverà solo gli aggiornamenti della sicurezza. È possibile continuare a usarlo come al solito fino al ritiro nell'ottobre 2023, quando verrà rimosso da tutti i servizi di Gestione API.

Portale per sviluppatori di Gestione API

Disponibilità

Importante

Questa funzionalità è disponibile nei livelli Premium, Standard, Basic e Developer di Gestione API.

Per la disponibilità delle funzionalità nei livelli v2 (anteprima), vedere panoramica dei livelli v2.

Miglioramenti nel nuovo portale per sviluppatori

Il nuovo portale per sviluppatori risolve molte limitazioni del portale deprecato. Include un editor di trascinamento della selezione visiva per la modifica del contenuto e un pannello dedicato per i progettisti per definire lo stile del sito Web. Le pagine, le personalizzazioni e la configurazione vengono salvate come risorse di Azure Resource Manager nel servizio Gestione API, che consente di automatizzare le distribuzioni del portale. Infine, la codebase del portale è open source, quindi è possibile estenderla con funzionalità personalizzate.

Come eseguire la migrazione la nuovo portale per sviluppatori

Il nuovo portale per sviluppatori non è compatibile con il portale deprecato e la migrazione automatica non è possibile. È necessario ricreare manualmente il contenuto (pagine, testo, file multimediali) e personalizzare l'aspetto del nuovo portale. I passaggi precisi variano a seconda delle personalizzazioni e della complessità del portale. Per indicazioni, vedere l'esercitazione sul portale per sviluppatori . La configurazione rimanente, ad esempio l'elenco di API, prodotti, utenti, provider di identità, viene condivisa automaticamente tra entrambi i portali.

Importante

Se in precedenza è stato avviato il nuovo portale per sviluppatori, ma non sono state apportate modifiche, reimpostare il contenuto predefinito per aggiornarlo alla versione più recente.

Quando si esegue la migrazione dal portale deprecato, tenere presente le modifiche seguenti:

  • Se si espone il portale per sviluppatori tramite un dominio personalizzato, assegnare un dominio al nuovo portale per sviluppatori. Usare l'opzione Portale per sviluppatori nell'elenco a discesa nel portale di Azure.

  • Applicare un criterio CORS alle API per abilitare la console di test interattiva.

  • Se si inserisce css personalizzato per applicare uno stile al portale, è necessario replicare lo stile usando il pannello di progettazione predefinito. L'inserimento CSS non è consentito nel nuovo portale.

  • È possibile inserire JavaScript personalizzato solo nella versione self-hosted del nuovo portale.

  • Se il Gestione API si trova in una rete virtuale ed è esposto a Internet tramite gateway applicazione, fare riferimento a questo articolo della documentazione per i passaggi di configurazione precisi. È necessario:

    • Abilitare la connettività all'endpoint di gestione del Gestione API.
    • Abilitare la connettività al nuovo endpoint del portale.
    • Disabilitare le regole di Web application firewall selezionate.

  • Se sono stati modificati i modelli di notifica di posta elettronica predefiniti per includere un URL del portale deprecato definito in modo esplicito, modificarli in modo da usare il parametro URL del portale o puntare al nuovo URL del portale. Se i modelli usano invece il parametro URL del portale predefinito, non sono necessarie modifiche.

  • Problemi e applicazioni non sono supportati nel nuovo portale per sviluppatori.

  • L'integrazione diretta con Facebook, Microsoft, Twitter e Google come provider di identità non è supportata nel nuovo portale per sviluppatori. È possibile eseguire l'integrazione con tali provider tramite Azure AD B2C.

  • Se si usa la delega, modificare l'URL restituito nelle applicazioni e usare l'endpoint dell'API Get Shared Access Token anziché l'endpoint Genera URL SSO.

  • Se si usa Microsoft Entra ID come provider di identità:

    • Modificare l'URL restituito nell'applicazione in modo che punti al nuovo dominio del portale per sviluppatori.
    • Modificare il suffisso dell'URL restituito nell'applicazione da /signin-aad a /signin.

  • Se si usa Azure AD B2C come provider di identità:

    • Modificare l'URL restituito nell'applicazione in modo che punti al nuovo dominio del portale per sviluppatori.
    • Modificare il suffisso dell'URL restituito nell'applicazione da /signin-aad a /signin.
    • Includere il nome, il cognome e l'ID oggetto dell'utente nelle attestazioni dell'applicazione .

  • Se si usa OAuth 2.0 nella console di test interattiva, modificare l'URL restituito nell'applicazione in modo che punti al nuovo dominio del portale per sviluppatori e modificare il suffisso:

    • Da /docs/services/[serverName]/console/oauth2/authorizationcode/callback a /signin-oauth/code/callback/[serverName] per il flusso di concessione del codice di autorizzazione.
    • Da /docs/services/[serverName]/console/oauth2/implicit/callback a /signin-oauth/implicit/callback per il flusso di concessione implicita.

  • Se si usa OpenID Connect nella console di test interattiva, modificare l'URL restituito nell'applicazione in modo che punti al nuovo dominio del portale per sviluppatori e modificare il suffisso:

    • Da /docs/services/[serverName]/console/openidconnect/authorizationcode/callback a /signin-oauth/code/callback/[serverName] per il flusso di concessione del codice di autorizzazione.
    • Da /docs/services/[serverName]/console/openidconnect/implicit/callback a /signin-oauth/implicit/callback per il flusso di concessione implicita.

Passaggi successivi

Altre informazioni sul portale per sviluppatori: