Eseguire la migrazione del portale API con il piano Enterprise di Azure Spring Apps ad Azure Gestione API

Nota

I piani Basic, Standard ed Enterprise saranno deprecati a partire dalla metà di marzo 2025, con un periodo di ritiro di 3 anni. È consigliabile eseguire la transizione ad App Azure Container. Per altre informazioni, vedere l'annuncio di ritiro di Azure Spring Apps.

Il piano Standard a consumo e dedicato sarà deprecato a partire dal 30 settembre 2024, con un arresto completo dopo sei mesi. È consigliabile eseguire la transizione ad App Azure Container. Per altre informazioni, vedere Eseguire la migrazione del consumo di Azure Spring Apps Standard e del piano dedicato alle app Azure Container.

Questo articolo si applica a: ❎ Basic/Standard ✅ Enterprise

Questo articolo descrive come eseguire la migrazione del portale API ad Azure Gestione API.

Azure Gestione API fornisce un'interfaccia centralizzata per la visualizzazione delle definizioni api e il test di route API specifiche direttamente dal browser. Supporta anche l'accesso Single Sign-On (SSO) per migliorare la sicurezza e l'accesso facile. La migrazione dal portale api con Azure Spring Apps ad Azure Gestione API migliora la scalabilità, la sicurezza e l'integrazione con altri servizi di Azure.

Prerequisiti

• Un'istanza del piano enterprise di Azure Spring Apps esistente con il portale per le API abilitato.
• Un'app contenitore di Azure esistente. Per altre informazioni, vedere Avvio rapido: Distribuire la prima app contenitore usando il portale di Azure.

Creare un'istanza di Gestione API

Usare la procedura seguente per creare un'istanza di Gestione API:

1. Nella portale di Azure cercare Gestione API nella barra di ricerca.

2. Selezionare Gestione API servizi nei risultati e quindi selezionare Crea.

3. Specificare le informazioni obbligatorie seguenti:

   • Sottoscrizione: selezionare la sottoscrizione di Azure per il servizio.
   • Gruppo di risorse: selezionare un gruppo di risorse esistente o selezionare Crea nuovo per crearne uno nuovo.
   • Area: scegliere la località o l'area per l'istanza di Gestione API.
   • Nome risorsa: specificare un nome univoco globale per l'istanza di Gestione API.
   • Nome organizzazione: specificare il nome dell'organizzazione.
   • Posta elettronica amministratore: specificare un indirizzo di posta elettronica usato per le notifiche relative all'istanza di Gestione API.

4. Scegliere il piano tariffario in base al caso d'uso. È sempre possibile aggiornare o modificare il piano tariffario in un secondo momento.

5. Configurare impostazioni facoltative come il monitoraggio e le impostazioni della rete virtuale.

6. Selezionare Rivedi e crea per esaminare le impostazioni e convalidare la configurazione.

7. Al termine della convalida, selezionare Crea. La distribuzione può richiedere da 30 a 40 minuti.

8. Al termine della distribuzione, passare alla pagina del servizio Gestione API per visualizzare il servizio appena creato.

Importare API esposte in Gestione API

Esistono due opzioni per importare API in Gestione API: aggiunta manuale di API o importazione di un file di specifiche API.

Aggiungere manualmente le API

Usare la procedura seguente per aggiungere manualmente le API:

1. Passare all'istanza di Gestione API nel portale di Azure. Nella sezione API selezionare Aggiungi API.

2. Nel riquadro Definisci una nuova API selezionare l'opzione HTTP per definire manualmente un'API HTTP.

3. Specificare i valori di base dell'API seguenti e quindi selezionare Crea per salvare:

   • Nome visualizzato: specificare un nome per l'API.
   • Nome: immettere un identificatore univoco per l'API.
   • URL servizio Web: specificare l'URL di base dell'API back-end delle app contenitore.
   • Suffisso URL API: definire il suffisso per questa API, ad esempio /api/customers-service.

4. Per creare nuovi endpoint API, selezionare Aggiungi operazione e quindi seguire questa procedura:

   1. Fornire le informazioni generali. Nome visualizzato e nome di input.
   2. Specificare i dettagli per l'operazione, ad esempio il verboGET - HTTP, POSTe così via: URL, parametri di query, richiesta e risposta.
   3. Dopo aver aggiunto tutte le operazioni, salvare l'API.

5. Selezionare i nomi delle API aggiunte. È possibile visualizzare tutte le operazioni aggiunte nella scheda Progettazione .

Importare un file di specifica DELL'API

Se si dispone di una specifica OpenAPI, una definizione Swagger, delle API, è possibile importare direttamente in Gestione API seguendo questa procedura:

1. Passare all'istanza di Gestione API nel portale di Azure.

2. Aprire la sezione API in API.

3. Selezionare Aggiungi API.

4. Per Crea da definizione scegliere l'opzione OpenAPI , che crea un'interfaccia standard indipendente dal linguaggio per le API REST.

5. Usare la procedura seguente per creare un'API da una specifica OpenAPI:

   1. Se si dispone di un file di specifiche api locale, selezionare Seleziona un file per caricare il file. In alternativa, fornire un URL accessibile pubblicamente alla specifica OpenAPI.
   2. È possibile perfezionare ulteriormente le impostazioni api specificando i valori per il suffisso Nome visualizzato, Nome e URL API per le API.
   3. Per salvare le configurazioni, selezionare Crea.

6. Selezionare il nome delle API aggiunte. È possibile visualizzare tutte le operazioni aggiunte nella scheda Progettazione .

Provare le API in Gestione API

Azure Gestione API offre una console di test predefinita all'interno del portale di Azure, semplificando l'interazione con le API senza bisogno di strumenti esterni. Usare la procedura seguente per testare le API:

1. Passare all'istanza di Gestione API nel portale di Azure.

2. Nella sezione API selezionare l'API da testare dall'elenco.

3. Scegliere un'operazione. All'interno della pagina di panoramica dell'API è possibile visualizzare un elenco delle operazioni disponibili (endpoint). Selezionare l'operazione che si vuole testare.

4. Selezionare la scheda Test per aprirla all'interno del portale di Azure.

5. Configurare i parametri della richiesta. Immettere i parametri necessari per la richiesta, ad esempio parametri di percorso, parametri di query, intestazioni o corpo, a seconda del metodo API. Se un'API richiede un , Authorization Tokenassicurarsi di includerlo nell'intestazione .

6. Inviare la richiesta. Dopo aver specificato i dettagli della richiesta, selezionare Invia. La risposta dell'API viene visualizzata direttamente nella portale di Azure, inclusi il codice di risposta, il corpo della risposta e le intestazioni.

7. Esaminare la risposta. Esaminare i dati di risposta, i codici di stato e tutti i messaggi di errore che potrebbero indicare problemi con l'API o la richiesta.

Eseguire la migrazione dell'accesso Single Sign-On a Gestione API

Se si abilita l'accesso Single Sign-On (SSO) nel portale API e si vuole autenticare anche le richieste a Gestione API, seguire questa procedura per configurare l'identità in Gestione API:

1. Nel portale di Azure, passare all'istanza di Gestione API.

2. Passare a Identità del portale>per sviluppatori.

3. Selezionare Aggiungi e quindi Azure Active Directory.

4. Compilare i campi obbligatori:

   • ID client: l'applicazione o l'ID client dell'applicazione Microsoft Entra ID registrata.
   • Segreto client: segreto dell'applicazione Microsoft Entra ID.
   • Tenant di accesso: nome di dominio del tenant di Microsoft Entra ID, ad esempio yourcompany.onmicrosoft.com
   • URL di reindirizzamento: in https://{your-apim-instance}.developer.azure-api.net/signingenere .

5. Selezionare Aggiungi per salvare il provider di identità.

È necessario aggiungere l'URL di reindirizzamento all'elenco degli URL di reindirizzamento consentiti dell'app client Microsoft Entra ID prima di salvare il nuovo provider di identità aggiunto.

Per altre configurazioni per Gestione API, vedere la documentazione Gestione API.