Samouczek: pozorowanie odpowiedzi interfejsu API

DOTYCZY: Wszystkie warstwy usługi API Management

Interfejsy API backendu są importowane do usługi Azure API Management lub tworzone i zarządzane ręcznie. W krokach w tym samouczku opisano, jak wykonać następujące czynności:

• Użyj usługi API Management, aby utworzyć pusty interfejs API HTTP.
• Ręczne zarządzanie interfejsem API PROTOKOŁU HTTP.
• Ustaw zasady dla interfejsu API, aby zwracały przykładową odpowiedź.

Ta metoda umożliwia deweloperom kontynuowanie implementacji i testowania wystąpienia usługi API Management, nawet jeśli zaplecze nie jest dostępne do wysyłania rzeczywistych odpowiedzi.

Napiwek

Zespoły interfejsów API mogą używać tej funkcji w obszarach roboczych. Obszary robocze zapewniają izolowany dostęp administracyjny do interfejsów API i ich własnych środowisk uruchomieniowych API.

Możliwość tworzenia pozornych odpowiedzi jest przydatna w wielu scenariuszach:

• Gdy fasada interfejsu API została zaprojektowana jako pierwsza, a implementacja zaplecza nastąpi później lub gdy zaplecze jest opracowywane równolegle.
• Gdy backend tymczasowo nie działa lub nie jest w stanie się skalować.

Z tego samouczka dowiesz się, jak wykonywać następujące czynności:

• Tworzenie testowego interfejsu API
• Dodawanie operacji do testowego interfejsu API
• Włączanie pozorowania odpowiedzi
• Przetestuj pozorowany interfejs API

Wymagania wstępne

• Poznaj terminologię usługi API Management.
• Omówienie koncepcji zasad w usłudze API Management.
• Ukończ szybki start Tworzenie wystąpienia usługi Azure API Management.

Tworzenie testowego interfejsu API

W krokach w tej sekcji pokazano, jak utworzyć interfejs API HTTP bez zaplecza.

1. Zaloguj się do portalu Azure, a następnie przejdź do instancji usługi API Management.

2. Wybierz APIs>+ Dodaj interfejs API> kafelek HTTP:

   

3. W oknie Tworzenie interfejsu API HTTP wybierz pozycję Pełny.

4. W polu Nazwa wyświetlana wprowadź wartość Test API.

5. W obszarze Produkty wybierz pozycję Nieograniczone, jeśli ta wartość jest dostępna. Ta wartość jest dostępna tylko w niektórych poziomach cenowych. Możesz pozostawić wartość pustą dla tego samouczka, ale musisz skojarzyć interfejs API z produktem, aby go opublikować. Aby uzyskać więcej informacji, zobacz Importowanie i publikowanie pierwszego interfejsu API.

6. W obszarze Bramy wybierz pozycję Zarządzane , jeśli ta opcja jest dostępna. (Ta opcja jest dostępna tylko w niektórych warstwach usług).

7. Wybierz pozycję Utwórz.

   

Dodawanie operacji do testowego interfejsu API

Interfejs API uwidacznia co najmniej jedną operację. W tej sekcji dodasz operację do utworzonego interfejsu API HTTP. Wywołanie operacji po wykonaniu kroków w tej sekcji powoduje wystąpienie błędu. Po wykonaniu kroków w sekcji Włączanie pozorowania odpowiedzi nie zostanie wyświetlony błąd.

Portal

1. Wybierz interfejs API utworzony w poprzednim kroku.

2. Wybierz opcję + Dodaj operację.

3. W oknie Frontonu wprowadź następujące wartości:

   Ustawienie	Wartość	Opis
   Nazwa wyświetlana	Wywołanie testowe	Nazwa wyświetlana w portalu deweloperów.
   Adres URL (pierwsze pole)	GET	Wybierz jedno ze wstępnie zdefiniowanych zleceń HTTP.
   Adres URL (drugie pole)	/test	Ścieżka adresu URL dla interfejsu API.
   Opis		Opcjonalny opis operacji. Zawiera on dokumentację w portalu dla deweloperów, którzy korzystają z interfejsu API.

   

4. Wybierz kartę Odpowiedzi , która znajduje się w polach Adres URL, Nazwa wyświetlana i Opis . Na tej karcie wprowadzisz wartości, aby zdefiniować kody stanu odpowiedzi, typy zawartości, przykłady i schematy.

5. Wybierz pozycję + Dodaj odpowiedź, a następnie wybierz pozycję 200 OK z listy.

   

6. W sekcji Reprezentacje wybierz pozycję + Dodaj reprezentację.

7. Wprowadź application/json w polu wyszukiwania, a następnie wybierz typ treści application/json.

8. W polu Przykład wprowadź { "sampleField" : "test" }.

9. Wybierz pozycję Zapisz.

   

Chociaż nie jest to wymagane w tym przykładzie, można skonfigurować więcej ustawień operacji interfejsu API na innych kartach, zgodnie z opisem w poniższej tabeli:

Zakładka	Opis
Zapytanie	Dodaj parametry zapytania. Oprócz podania nazwy i opisu można również podać wartości przypisane do parametru zapytania. Możesz oznaczyć jedną z wartości jako domyślnych (opcjonalnie).
Zażądaj	Definiowanie typów zawartości żądań, przykładów i schematów.

Azure CLI

Aby rozpocząć korzystanie z interfejsu wiersza polecenia platformy Azure:

• Użyj środowiska powłoki Bash w usłudze Azure Cloud Shell. Aby uzyskać więcej informacji, zobacz Rozpoczynanie pracy z usługą Azure Cloud Shell.

  

• Jeśli wolisz uruchamiać polecenia referencyjne interfejsu wiersza polecenia lokalnie, zainstaluj interfejs wiersza polecenia platformy Azure. Jeśli korzystasz z systemu Windows lub macOS, rozważ uruchomienie interfejsu wiersza polecenia platformy Azure w kontenerze Docker. Aby uzyskać więcej informacji, zobacz Jak uruchomić interfejs wiersza polecenia platformy Azure w kontenerze platformy Docker.

  • Jeśli korzystasz z instalacji lokalnej, zaloguj się do interfejsu wiersza polecenia platformy Azure za pomocą polecenia az login. Aby ukończyć proces uwierzytelniania, wykonaj kroki wyświetlane w terminalu. Aby uzyskać inne opcje logowania, zobacz Uwierzytelnianie na platformie Azure przy użyciu interfejsu wiersza polecenia platformy Azure.

  • Gdy pojawi się prośba, zainstaluj rozszerzenie Azure CLI przy pierwszym użyciu. Aby uzyskać więcej informacji na temat rozszerzeń, zobacz Używanie rozszerzeń i zarządzanie nimi za pomocą interfejsu wiersza polecenia platformy Azure.

  • Uruchom polecenie az version, aby znaleźć zainstalowane wersje i biblioteki zależne. Aby uaktualnić do najnowszej wersji, uruchom polecenie az upgrade.

Aby dodać operację do testowego interfejsu API, uruchom az apim api operation create:

az apim api operation create --resource-group <resource-group> \
    --display-name "Test call" --api-id test-api --method GET \
    --url-template /test --service-name <API-management-service-name> 

Uruchom polecenie az apim api operation list, aby wyświetlić wszystkie operacje dla interfejsu API:

az apim api operation list --resource-group <resource-group-name> \
    --api-id test-api --service-name <API-management-service-name> --output table

Zachowaj tę operację do użycia w pozostałej części tego artykułu. Jeśli chcesz usunąć operację, możesz użyć polecenia az apim api operation delete . Pobierz identyfikator operacji z poprzedniego polecenia.

az apim api operation delete --resource-group <resource-group-name> \
    --api-id test-api --operation-id <ID> \
    --service-name <API-management-service-name>

Włączanie pozorowania odpowiedzi

1. Wybierz interfejs API utworzony w sekcji Tworzenie testowego interfejsu API.

2. Upewnij się, że wybrano kartę Projekt .

3. Wybierz dodaną operację testową.

4. W sekcji Przetwarzanie przychodzące wybierz + Dodaj politykę.

   

5. Wybierz kafelek Mock responses (Pozorowanie odpowiedzi) z galerii:

   

6. Upewnij się, czy 200 OK, application/json pojawia się w polu odpowiedzi API Management. Ten wybór wskazuje, że interfejs API powinien zwrócić przykład odpowiedzi zdefiniowany w poprzedniej sekcji.

   

7. Wybierz pozycję Zapisz.

   Napiwek

   Pojawia się żółty pasek z tekstem Włączone pozorowanie. Ten komunikat wskazuje, że odpowiedzi zwrócone z usługi API Management są pozorowane przez politykę pozorowania i nie są generowane przez zaplecze.

Przetestuj symulowany interfejs API

1. Wybierz interfejs API utworzony w sekcji Tworzenie testowego interfejsu API.

2. Na karcie Test upewnij się, że wybrano interfejs API wywołania testowego , a następnie wybierz pozycję Wyślij , aby wykonać wywołanie testowe:

   

3. Odpowiedź HTTP wyświetla kod JSON podany jako przykład w pierwszej sekcji samouczka:

   

Następny krok

Przejdź do następnego samouczka:

Przekształcanie i ochrona opublikowanego interfejsu API