Samouczek: importowanie interfejsów API i zarządzanie nimi za pomocą rozszerzenia usługi Azure API Management dla programu Visual Studio Code

DOTYCZY: Zużycie | Deweloper | Podstawowa | Standardowa | Premium

Z tego samouczka dowiesz się, jak używać rozszerzenia usługi API Management dla programu Visual Studio Code na potrzeby typowych operacji w usłudze API Management. Użyj znanego środowiska programu Visual Studio Code do importowania, aktualizowania, testowania i zarządzania interfejsami API.

Dowiedz się, jak odbywa się:

• Importowanie interfejsu API do usługi API Management
• Edytowanie interfejsu API
• Stosowanie zasad usługi API Management
• Testowanie interfejsu API

Aby zapoznać się z wprowadzeniem do dodatkowych funkcji usługi API Management, zobacz samouczki usługi API Management korzystające z witryny Azure Portal.

Wymagania wstępne

• Omówienie terminologii usługi Azure API Management.
• Upewnij się, że zainstalowano program Visual Studio Code i najnowsze rozszerzenie usługi Azure API Management dla programu Visual Studio Code.
• Utwórz wystąpienie usługi API Management.

Importowanie interfejsu API

Poniższy przykład importuje specyfikację interfejsu OpenAPI w formacie JSON do usługi API Management. Firma Microsoft udostępnia interfejs API zaplecza używany w tym przykładzie i hostuje go na platformie Azure pod adresem https://conferenceapi.azurewebsites.net.

1. W programie Visual Studio Code wybierz ikonę platformy Azure na pasku działań.
2. W okienku Eksplorator rozwiń utworzone wystąpienie usługi API Management.
3. Kliknij prawym przyciskiem myszy interfejsy API i wybierz pozycję Importuj z linku OpenAPI.
4. Po wyświetleniu monitu wprowadź następujące wartości:

   1. Link openAPI dla zawartości w formacie JSON. Na potrzeby tego przykładu: https://conferenceapi.azurewebsites.net?format=json.

      Ten plik określa usługę zaplecza, która implementuje przykładowy interfejs API, w tym przypadku https://conferenceapi.azurewebsites.net. Usługa API Management przekazuje żądania do tej usługi internetowej.

   2. Nazwa interfejsu API, taka jak demo-conference-api, unikatowa w wystąpieniu usługi API Management. Ta nazwa może zawierać tylko litery, cyfry i łączniki. Pierwsze i ostatnie znaki muszą być alfanumeryczne. Ta nazwa jest używana w ścieżce do wywoływania interfejsu API.

Po pomyślnym zaimportowaniu interfejsu API pojawi się on w okienku Eksplorator, a dostępne operacje interfejsu API są wyświetlane w węźle Operacje .

Edytowanie interfejsu API

Interfejs API można edytować w programie Visual Studio Code. Na przykład edytuj opis JSON usługi Resource Manager interfejsu API w oknie edytora, aby usunąć protokół HTTP używany do uzyskiwania dostępu do interfejsu API.

Aby edytować format interfejsu OpenAPI, kliknij prawym przyciskiem myszy nazwę interfejsu API w okienku Eksplorator i wybierz polecenie Edytuj interfejs OpenAPI. Wprowadź zmiany, a następnie wybierz pozycję Zapisz plik>.

Stosowanie zasad do interfejsu API

Usługa API Management udostępnia zasady , które można skonfigurować dla interfejsów API. Zasady są kolekcją instrukcji. Te instrukcje są uruchamiane sekwencyjnie w żądaniu lub odpowiedzi interfejsu API. Zasady mogą być globalne, które mają zastosowanie do wszystkich interfejsów API w wystąpieniu usługi API Management lub specyficznych dla produktu, interfejsu API lub operacji interfejsu API.

W tej sekcji pokazano, jak zastosować typowe zasady ruchu wychodzącego do interfejsu API, które przekształcają odpowiedź interfejsu API. Zasady w tym przykładzie zmieniają nagłówki odpowiedzi i ukrywają oryginalne adresy URL zaplecza, które pojawiają się w treści odpowiedzi.

1. W okienku Eksplorator wybierz pozycję Zasady w zaimportowanym interfejsie demo-conference-api . Plik zasad zostanie otwarty w oknie edytora. Ten plik konfiguruje zasady dla wszystkich operacji w interfejsie API.

2. Zaktualizuj plik przy użyciu następującej zawartości w elemecie <outbound> :

   [...]
   <outbound>
       <set-header name="Custom" exists-action="override">
           <value>"My custom value"</value>
       </set-header>
       <set-header name="X-Powered-By" exists-action="delete" />
       <redirect-content-urls />
       <base />
   </outbound>
   [...]
   

   • Pierwsze set-header zasady dodają niestandardowy nagłówek odpowiedzi do celów demonstracyjnych.
   • Drugie set-header zasady usuwa nagłówek X-Powered-By , jeśli istnieje. Ten nagłówek może ujawnić strukturę aplikacji używaną w zapleczu interfejsu API, a wydawcy często go usuwają.
   • Zasady redirect-content-urls ponownie zapisuje łącza (maski) w treści odpowiedzi, aby wskazywały równoważne linki za pośrednictwem bramy usługi API Management.

3. Zapisz plik. Jeśli zostanie wyświetlony monit, wybierz pozycję Przekaż , aby przekazać plik do chmury.

Testowanie interfejsu API

Aby przetestować interfejs API, pobierz klucz subskrypcji, a następnie prześlij żądanie do bramy usługi API Management.

Pobieranie klucza subskrypcji

Aby przetestować zaimportowany interfejs API i zastosowane zasady, musisz mieć klucz subskrypcji dla wystąpienia usługi API Management.

1. W okienku Eksplorator kliknij prawym przyciskiem myszy nazwę wystąpienia usługi API Management.

2. Wybierz pozycję Kopiuj klucz subskrypcji. Ten klucz jest przeznaczony dla wbudowanej subskrypcji dostępu utworzonej podczas tworzenia wystąpienia usługi API Management.

   

   Uwaga

   Subskrypcja all-access umożliwia dostęp do każdego interfejsu API w tym wystąpieniu usługi API Management i powinna być używana tylko przez autoryzowanych użytkowników. Nigdy nie używaj go do rutynowego dostępu do interfejsu API ani osadzania klucza dostępu do wszystkich w aplikacjach klienckich.

Testowanie operacji interfejsu API

1. W okienku Eksplorator rozwiń węzeł Operacje w zaimportowanym interfejsie demo-conference-api .
2. Wybierz operację, taką jak GetSpeakers, a następnie kliknij prawym przyciskiem myszy operację i wybierz pozycję Operacja testu.
3. W oknie edytora obok pozycji Ocp-Apim-Subscription-Key zastąp {{SubscriptionKey}} skopiowanym kluczem subskrypcji.
4. Wybierz pozycję Wyślij wniosek.

Gdy żądanie zakończy się powodzeniem, zaplecze odpowie przy użyciu wartości 200 OK i niektórych danych.

Zwróć uwagę na następujące szczegóły w odpowiedzi:

• Nagłówek Niestandardowy jest dodawany do odpowiedzi.
• Nagłówek X-Powered-By nie jest wyświetlany w odpowiedzi.
• Adresy URL zaplecza interfejsu API są przekierowywane do bramy usługi API Management, w tym przypadku https://apim-hello-world.azure-api.net/demo-conference-api.

Przetwarzanie żądań śledzenia

Opcjonalnie możesz uzyskać szczegółowe informacje dotyczące śledzenia żądań, aby ułatwić debugowanie interfejsu API i rozwiązywanie problemów z tym interfejsem API.

Aby uzyskać instrukcje włączania śledzenia interfejsu API, zobacz Włączanie śledzenia dla interfejsu API. Aby ograniczyć niezamierzone ujawnienie poufnych informacji, śledzenie domyślnie jest dozwolone tylko przez 1 godzinę.

Czyszczenie zasobów

Gdy wystąpienie usługi API Management nie będzie już potrzebne, kliknij prawym przyciskiem myszy i wybierz polecenie Otwórz w portalu , aby usunąć usługę API Management i jej grupę zasobów.

Alternatywnie możesz wybrać pozycję Usuń usługę API Management, aby usunąć tylko wystąpienie usługi API Management (ta operacja nie powoduje usunięcia jej grupy zasobów).

Powiązana zawartość

W tym samouczku przedstawiono kilka funkcji rozszerzenia USŁUGI API Management dla programu Visual Studio Code. Za pomocą tych funkcji można importować interfejsy API i zarządzać nimi. W tym samouczku omówiono:

• Importowanie interfejsu API do usługi API Management
• Edytowanie interfejsu API
• Stosowanie zasad usługi API Management
• Testowanie interfejsu API

Rozszerzenie USŁUGI API Management udostępnia więcej funkcji do pracy z interfejsami API. Na przykład zasady debugowania (dostępne w warstwie usługi Deweloper) lub tworzenie nazwanych wartości i zarządzanie nimi.