Udostępnij za pośrednictwem

Debugowanie zasad usługi Azure API Management w programie Visual Studio Code

  • Artykuł

DOTYCZY: Deweloper

Zasady w usłudze Azure API Management zapewniają zaawansowane możliwości, które pomagają wydawcom interfejsów API rozwiązywać problemy związane z uwierzytelnianiem, autoryzacją, ograniczaniem przepustowości, buforowaniem i transformacją. Zasady to zbiór instrukcji, które są wykonywane sekwencyjnie podczas żądania lub odpowiedzi interfejsu API.

W tym artykule opisano sposób debugowania zasad usługi API Management przy użyciu rozszerzenia usługi Azure API Management dla programu Visual Studio Code.

Wymagania wstępne

Ograniczenia

  • Ta funkcja używa wbudowanej (poziomu usługi) subskrypcji dostępu do wszystkich (nazwa wyświetlana "Wbudowana subskrypcja z dostępem wszystkim") do debugowania.

Ważne

  • Śledzenie żądań usługi API Management nie może być już włączone, ustawiając nagłówek Ocp-Apim-Trace w żądaniu i używając wartości nagłówka Ocp-Apim-Trace-Location w odpowiedzi na pobranie śladu.
  • Aby zwiększyć bezpieczeństwo, śledzenie jest teraz włączone na poziomie pojedynczego interfejsu API przez uzyskanie tokenu ograniczonego czasowo przy użyciu interfejsu API REST usługi API Management i przekazanie tokenu w żądaniu do bramy. Aby uzyskać szczegółowe informacje, zobacz w dalszej części tego samouczka.
  • Należy zachować ostrożność podczas włączania śledzenia, ponieważ może uwidaczniać poufne informacje w danych śledzenia. Upewnij się, że masz odpowiednie środki bezpieczeństwa, aby chronić dane śledzenia.

Inicjowanie sesji debugowania

  1. Uruchom program Visual Studio Code.
  2. Przejdź do rozszerzenia usługi API Management w obszarze Rozszerzenia platformy Azure
  3. Znajdowanie wystąpienia usługi API Management do debugowania
  4. Znajdowanie interfejsu API i operacji do debugowania
  5. Kliknij prawym przyciskiem myszy operację i wybierz polecenie Rozpocznij debugowanie zasad

W tym momencie rozszerzenie spróbuje zainicjować i ustanowić sesję debugowania z bramą usługi API Management.

inicjowanie debugowania

Wysyłanie żądania testowego

Po ustanowieniu sesji debugowania rozszerzenie otworzy nowy edytor, który umożliwia utworzenie i wysłanie testowego żądania HTTP do tej operacji przy użyciu rozszerzenia klienta REST.

Zauważysz, że nagłówek Ocp-Apim-Debug został już dodany do żądania. Ten nagłówek jest wymagany, a wartość musi być ustawiona na klucz subskrypcji na poziomie usługi, aby wyzwolić funkcję debugowania w bramie usługi API Management.

Zmodyfikuj żądanie HTTP w edytorze zgodnie ze scenariuszem testowym. Następnie kliknij pozycję Wyślij żądanie , aby wysłać żądanie testowe do bramy usługi API Management.

wysyłanie żądania testowego

Debugowanie zasad

Po wysłaniu testowego żądania HTTP rozszerzenie otworzy okno debugowania z widocznymi obowiązującymi zasadami tej operacji i zatrzyma się przy pierwszych obowiązujących zasadach.

debugowanie zasad

Aby postępować zgodnie z potokiem zasad, można wykonać pojedynczy krok przez poszczególne zasady lub ustawić punkt przerwania w zasadach i przejść bezpośrednio do tych zasad.

Na panelu Zmienne można sprawdzić wartości zmiennych utworzonych przez system i utworzonych przez użytkownika. Na panelu Punkty przerwania można wyświetlić listę wszystkich ustawionych punktów przerwania. W panelu Stos wywołań można zobaczyć bieżący obowiązujący zakres zasad.

Jeśli podczas wykonywania zasad wystąpi błąd, zobaczysz szczegóły błędu w zasadach, w których wystąpiły.

wyjątki

Napiwek

Pamiętaj, aby zakończyć sesję debugowania, klikając przycisk Zatrzymaj po zakończeniu.

Następne kroki