API-portal migreren met Azure Spring Apps Enterprise-plan naar Azure API Management

Notitie

De Basic-, Standard- en Enterprise-abonnementen worden afgeschaft vanaf medio maart 2025, met een pensioenperiode van 3 jaar. We raden u aan om over te stappen naar Azure Container Apps. Zie de aankondiging over buitengebruikstelling van Azure Spring Apps voor meer informatie.

Het standaardverbruik en het speciale abonnement worden vanaf 30 september 2024 afgeschaft, met een volledige afsluiting na zes maanden. We raden u aan om over te stappen naar Azure Container Apps. Zie Azure Spring Apps Standard-verbruik en toegewezen abonnement migreren naar Azure Container Apps voor meer informatie.

Dit artikel is van toepassing op: ❎ Basic/Standard ✅ Enterprise

In dit artikel wordt beschreven hoe u API Portal migreert naar Azure API Management.

Azure API Management biedt een gecentraliseerde interface voor het weergeven van API-definities en het testen van specifieke API-routes rechtstreeks vanuit de browser. Het biedt ook ondersteuning voor eenmalige aanmelding (SSO) voor verbeterde beveiliging en naadloze toegang. Migreren van API Portal met Azure Spring Apps naar Azure API Management verbetert schaalbaarheid, beveiliging en integratie met andere Azure-services.

Vereisten

• Een bestaand Azure Spring Apps Enterprise-planexemplaren waarvoor API Portal is ingeschakeld.
• Een bestaande Azure-container-app. Zie voor meer informatie Quickstart: uw eerste container-app implementeren met behulp van Azure Portal.

Een API Management-exemplaar maken

Gebruik de volgende stappen om een API Management-exemplaar te maken:

1. Zoek in Azure Portal naar API Management in de zoekbalk.

2. Selecteer API Management-services in de resultaten en selecteer vervolgens Maken.

3. Geef de volgende vereiste informatie op:

   • Abonnement: Selecteer het Azure-abonnement voor uw service.
   • Resourcegroep: selecteer een bestaande resourcegroep of selecteer Nieuwe maken om een nieuwe te maken.
   • Regio: Kies de locatie of regio voor uw API Management-exemplaar.
   • Resourcenaam: geef een wereldwijd unieke naam op voor het API Management-exemplaar.
   • Organisatienaam: Geef de naam van uw organisatie op.
   • E-mailadres van beheerder: geef een e-mailadres op dat wordt gebruikt voor meldingen met betrekking tot het API Management-exemplaar.

4. Kies de prijscategorie op basis van uw use-case. U kunt de prijscategorie altijd later bijwerken of wijzigen.

5. Configureer optionele instellingen, zoals bewakings- en virtuele netwerkinstellingen.

6. Selecteer Beoordelen en maken om de instellingen te controleren en de configuratie te valideren.

7. Nadat de validatie is voltooid, selecteert u Maken. De implementatie kan 30 tot 40 minuten duren.

8. Nadat de implementatie is voltooid, gaat u naar de pagina van de API Management-service om de zojuist gemaakte service weer te geven.

Weergegeven API's importeren in API Management

Er zijn twee opties voor het importeren van API's in API Management: api's handmatig toevoegen of een API-specificatiebestand importeren.

API's handmatig toevoegen

Gebruik de volgende stappen om HANDMATIG API's toe te voegen:

1. Navigeer naar het API Management-exemplaar in Azure Portal. Selecteer API toevoegen in de sectie API's.

2. Selecteer in het deelvenster Een nieuwe API definiëren de HTTP-optie om handmatig een HTTP-API te definiëren.

3. Geef de volgende API Basics-waarden op en selecteer Vervolgens Maken om op te slaan:

   • Weergavenaam: Geef een naam op voor uw API.
   • Naam: Voer een unieke id in voor de API.
   • Webservice-URL: geef de basis-URL op van uw back-end-API van uw Container Apps.
   • API-URL-achtervoegsel: definieer het achtervoegsel voor deze API, bijvoorbeeld /api/customers-service.

4. Als u nieuwe API-eindpunten wilt maken, selecteert u Bewerking toevoegen en gebruikt u vervolgens de volgende stappen:

   1. Geef de algemene informatie op. Weergavenaam en -naam invoeren.
   2. Geef de details op voor de bewerking, zoals het HTTP-werkwoord - GET, POSTenzovoort: URL, queryparameters, aanvraag en antwoord.
   3. Nadat u alle bewerkingen hebt toegevoegd, slaat u uw API op.

5. Selecteer de namen van de TOEGEVOEGDE API's. U kunt alle bewerkingen zien die zijn toegevoegd op het tabblad Ontwerpen .

Een API-specificatiebestand importeren

Als u een OpenAPI-specificatie (een Swagger-definitie) van uw API's hebt, kunt u rechtstreeks importeren in API Management met behulp van de volgende stappen:

1. Navigeer naar het API Management-exemplaar in Azure Portal.

2. Open de sectie API's onder API's.

3. Selecteer API toevoegen.

4. Kies voor Maken op basis van definitie de Optie OpenAPI, waarmee een standaard, taalagnostische interface voor REST API's wordt gemaakt.

5. Gebruik de volgende stappen om een API te maken op basis van een OpenAPI-specificatie:

   1. Als u een lokaal API-specificatiebestand hebt, selecteert u Een bestand selecteren om het bestand te uploaden. U kunt ook een openbaar toegankelijke URL opgeven voor de OpenAPI-specificatie.
   2. U kunt de API-instellingen verder verfijnen door waarden op te geven voor het achtervoegsel weergavenaam, naam en API-URL voor de API's.
   3. Als u de configuraties wilt opslaan, selecteert u Maken.

6. Selecteer de naam van DE API's die zijn toegevoegd. U kunt alle bewerkingen zien die zijn toegevoegd op het tabblad Ontwerpen .

API's uitproberen in API Management

Azure API Management biedt een ingebouwde testconsole in Azure Portal, zodat u eenvoudig kunt communiceren met uw API's zonder dat u externe hulpprogramma's nodig hebt. Gebruik de volgende stappen om uw API's te testen:

1. Navigeer naar het API Management-exemplaar in Azure Portal.

2. Selecteer in de sectie API's de API die u wilt testen in de lijst.

3. Kies een bewerking. Op de overzichtspagina van de API ziet u een lijst met beschikbare bewerkingen (eindpunten). Selecteer de bewerking die u wilt testen.

4. Selecteer het tabblad Testen om het te openen in Azure Portal.

5. Configureer aanvraagparameters. Voer de benodigde parameters in voor de aanvraag, zoals padparameters, queryparameters, headers of hoofdtekst, afhankelijk van de API-methode. Als voor een API een Authorization TokenAPI is vereist, moet u deze opnemen in de header.

6. Verzend de aanvraag. Nadat u de aanvraaggegevens hebt opgegeven, selecteert u Verzenden. Het antwoord van de API wordt rechtstreeks weergegeven in Azure Portal, met inbegrip van de antwoordcode, de hoofdtekst van het antwoord en de headers.

7. Controleer het antwoord. Bekijk de antwoordgegevens, statuscodes en eventuele foutberichten die kunnen duiden op problemen met de API of aanvraag.

Eenmalige aanmelding migreren naar API Management

Als u eenmalige aanmelding (SSO) inschakelt in API Portal en aanvragen voor API Management wilt verifiëren, gebruikt u de volgende stappen om de identiteit in API Management te configureren:

1. Ga in Azure Portal naar uw API Management-exemplaar.

2. Navigeer naar identiteiten van de ontwikkelaarsportal>.

3. Selecteer Toevoegen en selecteer vervolgens Azure Active Directory.

4. Vul de vereiste velden in:

   • Client-id: de toepassing of client-id van uw geregistreerde Microsoft Entra ID-toepassing.
   • Clientgeheim: het geheim van de Microsoft Entra ID-toepassing.
   • Aanmeldingstenant: de domeinnaam van uw Microsoft Entra ID-tenant, zoals yourcompany.onmicrosoft.com
   • Omleidings-URL: meestal https://{your-apim-instance}.developer.azure-api.net/signin.

5. Selecteer Toevoegen om de id-provider op te slaan.

U moet de omleidings-URL toevoegen aan de lijst met toegestane omleidings-URL's van uw Microsoft Entra ID-client-app voordat u de nieuwe toegevoegde id-provider opslaat.

Zie de API Management-documentatie voor meer configuraties voor API Management.