Migrera API-portalen med Azure Spring Apps Enterprise-plan till Azure API Management

Kommentar

Basic-, Standard- och Enterprise-planerna kommer att vara inaktuella från och med mitten av mars 2025, med en 3-årig pensionsperiod. Vi rekommenderar att du övergår till Azure Container Apps. Mer information finns i meddelandet om azure Spring Apps-pensionering.

Standardförbrukningen och den dedikerade planen kommer att vara inaktuell från och med den 30 september 2024, med en fullständig avstängning efter sex månader. Vi rekommenderar att du övergår till Azure Container Apps. Mer information finns i Migrera Azure Spring Apps Standard-förbrukning och dedikerad plan till Azure Container Apps.

Den här artikeln gäller för: ❎ Basic/Standard ✅ Enterprise

I den här artikeln beskrivs hur du migrerar API-portalen till Azure API Management.

Azure API Management tillhandahåller ett centraliserat gränssnitt för att visa API-definitioner och testa specifika API-vägar direkt från webbläsaren. Det stöder också enkel inloggning (SSO) för förbättrad säkerhet och sömlös åtkomst. Migrering från API-portalen med Azure Spring Apps till Azure API Management förbättrar skalbarhet, säkerhet och integrering med andra Azure-tjänster.

Förutsättningar

• En befintlig Azure Spring Apps Enterprise-planinstans med API-portalen aktiverad.
• En befintlig Azure-containerapp. För mer information, se Snabbstart: Distribuera din första containerapp med hjälp av Azure-portalen.

Skapa en API Management-instans

Använd följande steg för att skapa en API Management-instans:

1. I Azure Portal söker du efter API Management i sökfältet.

2. Välj API Management-tjänster i resultatet och välj sedan Skapa.

3. Ange följande information som krävs:

   • Prenumeration: Välj Azure-prenumerationen för din tjänst.
   • Resursgrupp: Välj antingen en befintlig resursgrupp eller skapa en ny genom att välja Skapa ny .
   • Region: Välj plats eller region för DIN API Management-instans.
   • Resursnamn: Ange ett globalt unikt namn för API Management-instansen.
   • Organisationsnamn: Ange namnet på din organisation.
   • E-post för administratör: Ange en e-postadress som används för meddelanden som rör API Management-instansen.

4. Välj prisnivå baserat på ditt användningsfall. Du kan alltid uppgradera eller ändra prisnivån senare.

5. Konfigurera valfria inställningar som övervakning och inställningar för virtuella nätverk.

6. Välj Granska + skapa för att granska inställningarna och verifiera konfigurationen.

7. När verifieringen är klar väljer du Skapa. Distributionen kan ta 30 till 40 minuter.

8. När distributionen är klar går du till sidan API Management-tjänst för att visa den nyligen skapade tjänsten.

Importera exponerade API:er i API Management

Det finns två alternativ för att importera API:er i API Management: lägga till API:er manuellt eller importera en API-specifikationsfil.

Lägga till API:er manuellt

Använd följande steg för att lägga till API:er manuellt:

1. Gå till API Management-instansen i Azure Portal. Under avsnittet API:er väljer du Lägg till API.

2. I fönstret Definiera ett nytt API väljer du HTTP-alternativet för att manuellt definiera ett HTTP-API.

3. Ange följande API Basics-värden och välj sedan Skapa för att spara:

   • Visningsnamn: Ange ett namn för ditt API.
   • Namn: Ange en unik identifierare för API:et.
   • Webbtjänst-URL: Ange bas-URL:en för serverdels-API:et för dina Container Apps.
   • API URL-suffix: Definiera suffixet för det här API:et – till exempel /api/customers-service.

4. Om du vill skapa nya API-slutpunkter väljer du Lägg till åtgärd och använder sedan följande steg:

   1. Ange allmän information. Visningsnamn och namn för indata.
   2. Ange information om åtgärden, till exempel HTTP-verbet - GET, POST, och så vidare – URL, frågeparametrar, begäran och svar.
   3. När du har lagt till alla åtgärder sparar du ditt API.

5. Välj namnen på de API:er som har lagts till. Du kan se alla åtgärder som har lagts till på fliken Design .

Importera en API-specifikationsfil

Om du har en OpenAPI-specifikation – en Swagger-definition – för dina API:er kan du importera direkt till API Management med hjälp av följande steg:

1. Gå till API Management-instansen i Azure Portal.

2. Öppna avsnittet API:er under API:er.

3. Välj Lägg till API.

4. För Skapa från definition väljer du alternativet OpenAPI , som skapar ett standardspråkagnostiskt gränssnitt till REST-API:er.

5. Använd följande steg för att skapa ett API från en OpenAPI-specifikation:

   1. Om du har en lokal API-specifikationsfil väljer du Välj en fil för att ladda upp filen. Alternativt kan du ange en offentligt tillgänglig URL till OpenAPI-specifikationen .
   2. Du kan förfina API-inställningarna ytterligare genom att ange värden för suffixet Visningsnamn, Namn och API URL för API:erna.
   3. Spara konfigurationerna genom att välja Skapa.

6. Välj namnet på API:er som har lagts till. Du kan se alla åtgärder som lagts till på fliken Design .

Testa API:er i API Management

Azure API Management tillhandahåller en inbyggd testkonsol i Azure Portal, vilket gör det enkelt att interagera med dina API:er utan att behöva externa verktyg. Använd följande steg för att testa dina API:er:

1. Gå till API Management-instansen i Azure Portal.

2. Under avsnittet API:er väljer du det API som du vill testa i listan.

3. Välj en åtgärd. På API:ets översiktssida kan du se en lista över tillgängliga åtgärder (slutpunkter). Välj den åtgärd som du vill testa.

4. Välj fliken Test för att öppna den i Azure Portal.

5. Konfigurera parametrar för begäran. Ange nödvändiga parametrar för begäran, till exempel sökvägsparametrar, frågeparametrar, rubriker eller brödtext, beroende på API-metoden. Om ett API kräver ett Authorization Tokenmåste du ta med det i rubriken.

6. Skicka begäran. När du har angett information om begäran väljer du Skicka. Svaret från API:et visas direkt i Azure Portal, inklusive svarskoden, svarstexten och rubrikerna.

7. Kontrollera svaret. Granska svarsdata, statuskoder och eventuella felmeddelanden som kan tyda på problem med API:et eller begäran.

Migrera enkel inloggning till API Management

Om du aktiverar enkel inloggning (SSO) i API-portalen och även vill autentisera begäranden till API Management använder du följande steg för att konfigurera identiteten i API Management:

1. I Azure Portal går du till din API Management-instans.

2. Gå till Utvecklarportalens>identiteter.

3. Välj Lägg till och sedan Azure Active Directory.

4. Fyll i de obligatoriska fälten:

   • Klient-ID: Programmet eller klient-ID:t för ditt registrerade Microsoft Entra-ID-program.
   • Klienthemlighet: Hemligheten för Microsoft Entra-ID-programmet.
   • Inloggningsklient: Domännamnet för din Microsoft Entra ID-klientorganisation, till exempel yourcompany.onmicrosoft.com
   • Omdirigerings-URL: Vanligtvis https://{your-apim-instance}.developer.azure-api.net/signin.

5. Välj Lägg till för att spara identitetsprovidern.

Du måste lägga till omdirigerings-URL:en i listan över tillåtna omdirigerings-URL:er för din Microsoft Entra-ID-klientapp innan du sparar den nya tillagda identitetsprovidern.

Fler konfigurationer för API Management finns i API Management-dokumentationen.