Udostępnij za pośrednictwem

Włączanie mechanizmu CORS dla konsoli interaktywnej w portalu deweloperów usługi API Management

  • Artykuł

Współużytkowanie zasobów między źródłami (CORS) to mechanizm oparty na nagłówku HTTP, który umożliwia serwerowi wskazanie wszelkich źródeł (domen, schematów lub portów), z których przeglądarka powinna zezwalać na ładowanie zasobów.

Aby umożliwić odwiedzającym portal deweloperów usługi API Management korzystanie z interaktywnej konsoli testowej na stronach referencyjnych interfejsu API, włącz zasady CORS dla interfejsów API w wystąpieniu usługi API Management. Jeśli nazwa domeny portalu deweloperów nie jest dozwolonym źródłem żądań interfejsu API między domenami, użytkownicy konsoli testowej zobaczą błąd CORS.

W niektórych scenariuszach można skonfigurować portal dla deweloperów jako serwer proxy CORS zamiast włączania zasad CORS dla interfejsów API.

DOTYCZY: Developer | Podstawowa | Standardowa | Premium

Wymagania wstępne

Przechodzenie do wystąpienia usługi API Management

  1. W witrynie Azure Portal wyszukaj i wybierz pozycję Usługi API Management.

    Wybieranie usług API Management

  2. Na stronie Usługi API Management wybierz wystąpienie usługi API Management.

    Wybieranie wystąpienia usługi API Management

Włączanie zasad CORS dla interfejsów API

Możesz włączyć ustawienie automatycznego konfigurowania zasad CORS dla wszystkich interfejsów API w wystąpieniu usługi API Management. Można również ręcznie skonfigurować zasady CORS.

Uwaga

Jest wykonywana tylko jedna zasada CORS. Jeśli określisz wiele zasad CORS (na przykład na poziomie interfejsu API i na poziomie wszystkich interfejsów API), konsola interaktywna może nie działać zgodnie z oczekiwaniami.

Automatyczne włączanie zasad MECHANIZMU CORS

  1. W menu po lewej stronie wystąpienia usługi API Management w obszarze Portal dla deweloperów wybierz pozycję Przegląd portalu.
  2. W obszarze Włącz mechanizm CORS jest wyświetlany stan konfiguracji zasad CORS. Pole ostrzegawcze wskazuje nieobecne lub nieprawidłowo skonfigurowane zasady.
  3. Aby włączyć mechanizm CORS w portalu dla deweloperów dla wszystkich interfejsów API, wybierz pozycję Włącz mechanizm CORS.

Zrzut ekranu pokazujący, gdzie sprawdzić stan zasad CORS w portalu dla deweloperów.

Ręczne włączanie zasad MECHANIZMU CORS

  1. Wybierz link Ręcznie zastosuj go na poziomie globalnym, aby wyświetlić wygenerowany kod zasad.
  2. Przejdź do pozycji Wszystkie interfejsy API w sekcji Interfejsy API wystąpienia usługi API Management.
  3. Wybierz ikonę </> w sekcji Przetwarzanie przychodzące.
  4. W edytorze zasad wstaw zasady w <sekcji przychodzącej> pliku XML. Upewnij się, że <wartość źródła> jest zgodna z domeną portalu deweloperów.

Uwaga

Jeśli zastosujesz zasady CORS w zakresie Produktu, zamiast zakresu interfejsów API, a interfejs API używa uwierzytelniania klucza subskrypcji za pośrednictwem nagłówka, konsola nie będzie działać.

Przeglądarka automatycznie wysyła OPTIONS żądanie HTTP, które nie zawiera nagłówka z kluczem subskrypcji. Z powodu braku klucza subskrypcji usługa API Management nie może skojarzyć OPTIONS wywołania z produktem, więc nie może zastosować zasad CORS.

Aby obejść ten problem, możesz przekazać klucz subskrypcji w parametrze zapytania.

Opcja serwera proxy CORS

W przypadku niektórych scenariuszy (na przykład jeśli brama usługi API Management jest odizolowana od sieci), możesz skonfigurować portal deweloperów jako sam serwer proxy CORS, zamiast włączać zasady CORS dla interfejsów API. Serwer proxy CORS kieruje wywołania interfejsu API konsoli interakcyjnej za pośrednictwem zaplecza portalu w wystąpieniu usługi API Management.

Uwaga

Jeśli interfejsy API są uwidaczniane za pośrednictwem własnej bramy lub usługa znajduje się w sieci wirtualnej, wymagana jest łączność z usługi zaplecza portalu deweloperów usługi API Management do bramy.

Aby skonfigurować serwer proxy CORS, uzyskaj dostęp do portalu dla deweloperów jako administrator:

  1. Na stronie Przegląd wystąpienia usługi API Management wybierz pozycję Portal dla deweloperów. Portal dla deweloperów zostanie otwarty na nowej karcie przeglądarki.
  2. W menu po lewej stronie interfejsu administracyjnego wybierz pozycję Szczegóły interfejsów>API stron>.
  3. Na stronie Interfejsy API: Szczegóły wybierz widżet Operacja: Szczegóły i wybierz pozycję Edytuj widżet.
  4. Wybierz pozycję Użyj serwera proxy CORS.
  5. Zapisz zmiany w portalu i opublikuj ponownie portal.

Konfiguracja mechanizmu CORS dla portalu dla deweloperów ( self-hosted)

W przypadku samodzielnego hostowania portalu dla deweloperów wymagana jest następująca konfiguracja w celu włączenia mechanizmu CORS:

  • Określ punkt końcowy zaplecza portalu przy użyciu backendUrl opcji w plikach konfiguracji. W przeciwnym razie portal self-hosted nie jest świadomy lokalizacji usługi zaplecza.

  • Dodaj wartości domeny źródła do konfiguracji portalu własnego, określając środowiska, w których jest hostowany własny portal. Dowiedz się więcej

Powiązana zawartość