CORS inschakelen voor interactieve console in de API Management-ontwikkelaarsportal

  • Artikel

Cross-origin resource sharing (CORS) is een mechanisme op basis van HTTP-headers waarmee een server andere oorsprongen (domein, schema of poort) kan aangeven dan een eigen bron, waaruit een browser het laden van resources moet toestaan.

Als u bezoekers van de API Management-ontwikkelaarsportal de interactieve testconsole wilt laten gebruiken op de API-referentiepagina's, schakelt u een CORS-beleid in voor API's in uw API Management-exemplaar. Als de domeinnaam van de ontwikkelaarsportal geen toegestane oorsprong is voor API-aanvragen tussen domeinen, zien testconsolegebruikers een CORS-fout.

Voor bepaalde scenario's kunt u de ontwikkelaarsportal configureren als een CORS-proxy in plaats van een CORS-beleid in te schakelen voor API's.

VAN TOEPASSING OP: Ontwikkelaar | Basic | Standaard | Premium

Vereisten

Ga naar uw API Management-exemplaar

  1. Zoek en selecteer API Management-services in Azure Portal.

    API Management-services selecteren

  2. Selecteer uw API Management-exemplaar op de pagina API Management-services.

    Uw API Management-exemplaar selecteren

CORS-beleid voor API's inschakelen

U kunt een instelling inschakelen om automatisch een CORS-beleid te configureren voor alle API's in uw API Management-exemplaar. U kunt ook handmatig een CORS-beleid configureren.

Notitie

Er wordt slechts één CORS-beleid uitgevoerd. Als u meerdere CORS-beleidsregels opgeeft (bijvoorbeeld op API-niveau en op het niveau van alle API's), werkt uw interactieve console mogelijk niet zoals verwacht.

CORS-beleid automatisch inschakelen

  1. Selecteer in het linkermenu van uw API Management-exemplaar onder De ontwikkelaarsportal het portaloverzicht.
  2. Onder CORS inschakelen wordt de status van de configuratie van CORS-beleid weergegeven. Een waarschuwingsvak geeft een afwezig of onjuist geconfigureerd beleid aan.
  3. Als u CORS wilt inschakelen vanuit de ontwikkelaarsportal voor alle API's, selecteert u CORS inschakelen.

Schermopname van waar u de status van uw CORS-beleid kunt controleren in de ontwikkelaarsportal.

CORS-beleid handmatig inschakelen

  1. Selecteer de koppeling Handmatig toepassen op de koppeling op globaal niveau om de gegenereerde beleidscode weer te geven.
  2. Navigeer naar Alle API's in de sectie API's van uw API Management-exemplaar.
  3. Selecteer het </> -pictogram in de sectie Binnenkomende verwerking .
  4. Voeg in de beleidseditor het beleid in de <binnenkomende> sectie van het XML-bestand in. Zorg ervoor dat de <oorspronkelijke> waarde overeenkomt met het domein van de ontwikkelaarsportal.

Notitie

Als u het CORS-beleid toepast in het productbereik, in plaats van het API-bereik en uw API gebruikmaakt van verificatie van abonnementssleutels via een header, werkt uw console niet.

De browser geeft automatisch een OPTIONS HTTP-aanvraag uit, die geen header met de abonnementssleutel bevat. Vanwege de ontbrekende abonnementssleutel kan API Management de OPTIONS aanroep niet koppelen aan een product, zodat het CORS-beleid niet kan worden toegepast.

Als tijdelijke oplossing kunt u de abonnementssleutel doorgeven in een queryparameter.

CORS-proxyoptie

Voor sommige scenario's (bijvoorbeeld als de API Management-gateway is geïsoleerd van het netwerk), kunt u ervoor kiezen om de ontwikkelaarsportal te configureren als een CORS-proxy zelf in plaats van een CORS-beleid in te schakelen voor uw API's. De CORS-proxy routeert de API-aanroepen van de interactieve console via de back-end van de portal in uw API Management-exemplaar.

Notitie

Als de API's beschikbaar zijn via een zelf-hostende gateway of uw service zich in een virtueel netwerk bevindt, is de connectiviteit van de back-endservice van de API Management-ontwikkelaarsportal naar de gateway vereist.

Als u de CORS-proxy wilt configureren, opent u de ontwikkelaarsportal als beheerder:

  1. Selecteer op de pagina Overzicht van uw API Management-exemplaar de optie Ontwikkelaarsportal. De ontwikkelaarsportal wordt geopend op een nieuw browsertabblad.
  2. Selecteer in het linkermenu van de beheerinterface Pagina-API's>>Details.
  3. Selecteer op de API's: Detailpagina de widget Bewerking: Details en selecteer widget Bewerken.
  4. Selecteer CORS-proxy gebruiken.
  5. Sla wijzigingen op in de portal en publiceer de portal opnieuw.

CORS-configuratie voor zelf-hostende ontwikkelaarsportal

Als u de ontwikkelaarsportal zelf host , is de volgende configuratie nodig om CORS in te schakelen:

  • Geef het back-endeindpunt van de portal op met behulp van de backendUrl optie in de configuratiebestanden. Anders is de zelf-hostende portal niet op de hoogte van de locatie van de back-endservice.

  • Voeg origin-domeinwaarden toe aan de zelf-hostende portalconfiguratie die de omgevingen opgeeft waarin de zelf-hostende portal wordt gehost. Meer informatie

Gerelateerde inhoud

  • Zie Beleid instellen of bewerken voor meer informatie over het configureren van een beleid.
  • Zie de cors-beleidsverwijzing voor meer informatie over het CORS-beleid.