Een Azure-web-app importeren als API

2025-05-20

VAN TOEPASSING OP: Alle API Management-niveaus

In dit artikel wordt beschreven hoe u Azure Portal gebruikt om een Azure-web-app als API te importeren in Azure API Management en de geïmporteerde API te testen.

Notitie

Deze functie is momenteel niet beschikbaar in werkruimten.

In dit artikel leert u het volgende:

Een web-app importeren, die wordt gehost in Azure App Service, als API
De API testen in Azure Portal

Een web-app beschikbaar maken met BEHULP van API Management

Azure-app Service is een HTTP-service voor het hosten van webtoepassingen, REST API's en mobiele back-ends. API-ontwikkelaars kunnen hun voorkeurstechnologiestacks en pijplijnen gebruiken om API's te ontwikkelen en hun API-back-ends te publiceren als web-apps in een veilige, schaalbare omgeving. Vervolgens kunnen ze API Management gebruiken om de web-apps beschikbaar te maken, de API's gedurende hun levenscyclus te beheren en te beveiligen, en ze te publiceren naar consumenten.

Het gebruik van API Management om een door Web Apps gehoste API beschikbaar te maken biedt de volgende voordelen:

Koppel het beheer en de beveiliging van de front-end die beschikbaar is voor API-consumenten los van het beheren en bewaken van de back-endweb-app.
Web-API's beheren die worden gehost als web-apps in dezelfde omgeving als uw andere API's.
Pas beleidsregels toe om het API-gedrag te wijzigen, zoals het beperken van de aanroepsnelheid.
Directe API-gebruikers naar de aanpasbare API Management-ontwikkelaarsportal , zodat ze uw API's kunnen detecteren en leren, toegang kunnen aanvragen en API's kunnen proberen.

Zie Over API Management voor meer informatie.

OpenAPI-definitie versus jokertekenbewerkingen

API Management ondersteunt het importeren van web-apps die worden gehost in App Service met een OpenAPI-definitie (een Swagger-definitie). Er is echter geen OpenAPI-definitie vereist.

Als de web-app is geconfigureerd met een OpenAPI-definitie, detecteert API Management dat. U kunt de definitie ook handmatig importeren in API Management. API Management maakt vervolgens API-bewerkingen die rechtstreeks aan de definitie worden toegewezen, inclusief vereiste paden, parameters en antwoordtypen.

Het is raadzaam om een OpenAPI-definitie te gebruiken, omdat de API met hoge kwaliteit wordt geïmporteerd in API Management, waardoor u de flexibiliteit hebt om configuraties voor elke bewerking afzonderlijk te valideren, beheren, beveiligen en bij te werken.
Als er geen OpenAPI-definitie wordt opgegeven, genereert API Management jokertekenbewerkingen voor de algemene HTTP-woorden (GET, PUT, enzovoort). Voeg een vereist pad of parameters toe aan een jokertekenbewerking om een API-aanvraag door te geven aan de back-end-API.

Met jokertekenbewerkingen kunt u nog steeds profiteren van dezelfde API Management-functies, maar bewerkingen worden niet standaard op hetzelfde detailniveau gedefinieerd. In beide gevallen kunt u bewerkingen bewerken of toevoegen aan de geïmporteerde API.

Voorbeeld

Uw back-endweb-app ondersteunt mogelijk twee GET-bewerkingen:

https://<app-service>.azurewebsites.net/customer/{id}
https://<app-service>.azurewebsites.net/customers

U importeert de web-app in uw API Management-service op een pad zoals https://<api>.azureapi.net/store. In de volgende tabel ziet u de bewerkingen die worden geïmporteerd in API Management, met of zonder een OpenAPI-specificatie:

Typologie	Geïmporteerde bewerkingen	Voorbeeldaanvragen
OpenAPI-specificatie	`GET /customer/{id}` `GET /customers`	`GET https://<api>.azureapi.net/store/customer/1` `GET https://<api>.azureapi.net/store/customers`
Jokerteken	`GET /*`	`GET https://<api>.azureapi.net/store/customer/1` `GET https://<api>.azureapi.net/store/customers`

Met de jokertekenbewerking worden dezelfde aanvragen naar de back-endservice toegestaan als de bewerkingen in de OpenAPI-specificatie. De openAPI-opgegeven bewerkingen kunnen echter afzonderlijk worden beheerd in API Management.

Vereisten

Voltooi de Quickstart Een Azure API Management-exemplaar aanmaken.
Zorg ervoor dat uw abonnement een app-service heeft. Zie de App Service-documentatie voor meer informatie.

Zie voor meer informatie over het maken van een voorbeeldweb-API en het publiceren als een Azure-web-app:
- Zelfstudie: Een web-API maken met ASP.NET Core.
- Publiceer een ASP.NET Core-app naar Azure met Visual Studio Code.

Een API importeren en publiceren

Aanbeveling

In de volgende stappen start u het importeren met behulp van API Management in Azure Portal. U kunt ook rechtstreeks vanuit uw web-app een koppeling maken naar API Management door API Management te selecteren in het API-menu van de app.

Navigeer naar uw API Management-service in Azure Portal.
Selecteer API's in het linkermenu in de sectie API's en selecteer vervolgens + API toevoegen.
Selecteer de tegel App Service :
Selecteer Bladeren om de lijst met app-services in uw abonnement weer te geven.
Selecteer een app-service en klik vervolgens op de knop Selecteren . Als een OpenAPI-definitie is gekoppeld aan de geselecteerde web-app, haalt API Management deze op en importeert deze.

Als er geen OpenAPI-definitie wordt gevonden, maakt API Management de API beschikbaar door jokertekenbewerkingen te genereren voor algemene HTTP-werkwoorden.
Voeg een API-URL-achtervoegsel toe. Het achtervoegsel is een naam die de API in het API Management-exemplaar identificeert. Het moet uniek zijn in het API Management-exemplaar.
Als u wilt dat de API wordt gepubliceerd en beschikbaar is voor ontwikkelaars, schakelt u over naar de volledige weergave en koppelt u de API aan een product. In dit voorbeeld wordt het onbeperkte product gebruikt. (U kunt uw API toevoegen aan een product wanneer u deze maakt of later via het tabblad Instellingen .)
Notitie

Producten zijn koppelingen van een of meer API's die worden aangeboden aan ontwikkelaars via de ontwikkelaarsportal. Eerst moeten ontwikkelaars zich abonneren op een product om toegang te krijgen tot de API. Nadat ze zich hebben geabonneerd, krijgen ze een abonnementssleutel voor elke API in het product. Als maker van het API Management-exemplaar bent u een beheerder en bent u standaard geabonneerd op elk product.

In bepaalde lagen wordt elk API Management-exemplaar geleverd met twee standaardvoorbeeldproducten:
- Starter
- Onbeperkt
Voer andere API-instellingen in. U kunt deze waarden instellen wanneer u de API maakt of deze later configureren door naar het tabblad Instellingen te gaan. De instellingen worden uitgelegd in de zelfstudie Uw eerste API importeren en publiceren .
Selecteer Aanmaken.

De nieuwe API testen in de Azure-portal

U kunt bewerkingen rechtstreeks vanuit Azure Portal aanroepen. Deze methode biedt een handige manier om de bewerkingen van een API weer te geven en te testen. U kunt de API ook testen in de ontwikkelaarsportal of met behulp van uw eigen REST-clienthulpprogramma's.

Selecteer de API die u in de vorige stap hebt gemaakt.
Selecteer een bewerking op het tabblad Testen .

De pagina geeft velden weer voor queryparameters en velden voor de headers. Een van de headers is Ocp-Apim-Subscription-Key. Deze header is voor de abonnementssleutel van het product dat is gekoppeld aan de API. Als u het API Management-exemplaar hebt gemaakt, bent u al een beheerder, zodat de sleutel automatisch wordt ingevuld.
Druk op Verzenden.

Wanneer de test is geslaagd, reageert de back-end met 200 OK en enkele gegevens.

Een wildcardbewerking testen in het portaal

Wanneer jokertekenbewerkingen worden gegenereerd, worden de bewerkingen mogelijk niet rechtstreeks toegewezen aan de back-end-API. Een get-bewerking met jokertekens die in API Management wordt geïmporteerd, maakt bijvoorbeeld standaard gebruik van het pad / . Uw back-end-API ondersteunt echter mogelijk een GET-bewerking op het pad /api/todoItems.

Het pad /api/todoItems testen:

Selecteer de API die u hebt gemaakt en selecteer vervolgens een bewerking.
Werk op het tabblad Test, onder Sjabloonparameters, de waarde naast de jokerteken (*) naam bij. Voer bijvoorbeeld API/todoItems in. Deze waarde wordt toegevoegd aan het pad / voor de jokertekenbewerking.
Kies Verzenden.

Andere API's toevoegen

U kunt een API samenstellen uit API's die worden weergegeven door verschillende services, waaronder:

Een OpenAPI-specificatie
Een SOAP-API
Een GraphQL-API
Een web-app die wordt gehost in Azure App Service
Azure Functions (serverloze computerdiensten van Azure)
Azure Logic Apps
Azure Service Fabric

Notitie

Wanneer u een API importeert, worden de bewerkingen toegevoegd aan uw huidige API.

Een API toevoegen aan een bestaande API:

Ga naar uw Azure API Management-exemplaar in Azure Portal:
Selecteer API's op de Overzicht pagina of selecteer API's>API's in het menu aan de linkerkant.

Screenshot van de selectie van API's op de pagina 'Overzicht'.
Selecteer het beletselteken (#A0 ... #A1) naast de API waaraan u een andere API wilt toevoegen.
Selecteer Import uit het vervolgkeuzemenu.
Selecteer de service waaruit een API moet worden geïmporteerd.

Delen via