Povolení CORS pro interaktivní konzolu na portálu pro vývojáře služby API Management

  • Článek

Sdílení prostředků mezi zdroji (CORS) je mechanismus založený na hlavičce HTTP, který umožňuje serveru označit jakýkoli zdroj (doména, schéma nebo port), než je jeho vlastní, ze kterého by prohlížeč měl povolit načítání prostředků.

Pokud chcete návštěvníkům portálu pro vývojáře služby API Management umožnit použití interaktivní testovací konzoly na referenčních stránkách rozhraní API, povolte zásadu CORS pro rozhraní API ve vaší instanci služby API Management. Pokud název domény portálu pro vývojáře není povoleným zdrojem požadavků rozhraní API pro různé domény, zobrazí se uživatelům testovací konzoly chyba CORS.

V určitých scénářích můžete portál pro vývojáře nakonfigurovat jako proxy CORS místo povolení zásad CORS pro rozhraní API.

PLATÍ PRO: Vývojář | Základní | Standardní | Premium

Požadavky

Přejít k instanci služby API Management

  1. Na webu Azure Portal vyhledejte a vyberte služby API Management.

    Výběr služeb API Management

  2. Na stránce služby API Management vyberte instanci služby API Management.

    Výběr instance služby API Management

Povolení zásad CORS pro rozhraní API

Můžete povolit nastavení pro automatickou konfiguraci zásad CORS pro všechna rozhraní API ve vaší instanci služby API Management. Zásady CORS můžete nakonfigurovat také ručně.

Poznámka:

Spustí se jenom jedna zásada CORS. Pokud zadáte více zásad CORS (například na úrovni rozhraní API a na úrovni všech rozhraní API), vaše interaktivní konzola nemusí fungovat podle očekávání.

Automatické povolení zásad CORS

  1. V levé nabídce instance služby API Management v části Portál pro vývojáře vyberte Přehled portálu.
  2. V části Povolit CORS se zobrazí stav konfigurace zásad CORS. Pole upozornění označuje chybějící nebo chybně nakonfigurovanou zásadu.
  3. Pokud chcete CORS povolit na portálu pro vývojáře pro všechna rozhraní API, vyberte Povolit CORS.

Snímek obrazovky znázorňující, kde můžete zkontrolovat stav zásad CORS na portálu pro vývojáře

Ruční povolení zásad CORS

  1. Pokud chcete zobrazit vygenerovaný kód zásad, vyberte ho Ručně použít na odkazu na globální úrovni.
  2. V části Rozhraní API vaší instance služby API Management přejděte na všechna rozhraní API.
  3. <V části Zpracování příchozích dat vyberte ikonu />.
  4. V editoru zásad vložte zásadu do <příchozí> části souboru XML. Ujistěte se, že hodnota původu <> odpovídá doméně portálu pro vývojáře.

Poznámka:

Pokud použijete zásadu CORS v oboru produktu místo oboru rozhraní API a vaše rozhraní API používá ověřování pomocí klíče předplatného prostřednictvím hlavičky, konzola nebude fungovat.

Prohlížeč automaticky vydá OPTIONS požadavek HTTP, který neobsahuje hlavičku s klíčem předplatného. Kvůli chybějícímu klíči předplatného nemůže služba API Management přidružit OPTIONS volání k produktu, takže nemůže použít zásady CORS.

Alternativním řešením je předat klíč předplatného v parametru dotazu.

Možnost proxy SERVERU CORS

V některých scénářích (například pokud je brána SLUŽBY API Management izolovaná v síti), můžete portál pro vývojáře nakonfigurovat jako samotný proxy server CORS, a ne povolit zásady CORS pro vaše rozhraní API. Proxy server CORS směruje volání rozhraní API interaktivní konzoly prostřednictvím back-endu portálu v instanci služby API Management.

Poznámka:

Pokud jsou rozhraní API zpřístupněná prostřednictvím brány v místním prostředí nebo je vaše služba ve virtuální síti, vyžaduje se připojení z back-endové služby portálu pro vývojáře služby API Management k bráně.

Pokud chcete nakonfigurovat proxy CORS, přejděte na vývojářský portál jako správce:

  1. Na stránce Přehled vaší instance služby API Management vyberte Portál pro vývojáře. Portál pro vývojáře se otevře na nové kartě prohlížeče.
  2. V levé nabídce rozhraní pro správu vyberte Rozhraní API>stránky>Podrobnosti.
  3. Na stránce Rozhraní API: Podrobnosti vyberte operaci: widget Podrobnosti a vyberte Upravit widget.
  4. Vyberte Použít proxy server CORS.
  5. Uložte změny na portál a znovu publikujte portál.

Konfigurace CORS pro portál pro vývojáře v místním prostředí

Pokud sami hostujete portál pro vývojáře, je k povolení CORS potřeba následující konfigurace:

  • Pomocí možnosti v konfiguračních souborech zadejte koncový bod backendUrl back-endu portálu. Jinak místní portál nezná umístění back-endové služby.

  • Přidejte hodnoty domény Origin do konfigurace místního portálu a určete prostředí, kde je hostovaný místní portál. Další informace

Související obsah