Ćwiczenie — tworzenie bramy interfejsów API

  • 10 min

W tym ćwiczeniu wdrożysz przykładowy internetowy interfejs API i skonfigurujesz bramę interfejsu API. W kolejnej lekcji opublikujesz internetowy interfejs API w bramie.

W przykładzie firmy obuwniczej firma NorthWind Shoes zdecydowała się udostępnić interfejs API spisu partnerom. Ten interfejs API umożliwia partnerom uzyskanie dostępu do informacji o spisie i o produktach.

Ważne

Do wykonania tego ćwiczenia potrzebna jest własna subskrypcja platformy Azure. Ponadto mogą zostać naliczone opłaty. Jeśli nie masz jeszcze subskrypcji platformy Azure, przed rozpoczęciem utwórz bezpłatne konto.

Wdrażanie internetowego interfejsu API ShoeCompany

Utworzono aplikację .NET Core, która generuje informacje o spisie i produkcie. Ta aplikacja zawiera pakiet Swashbuckle w celu generowania dokumentacji struktury Swagger interfejsu OpenAPI.

Aby zaoszczędzić czas, zacznijmy od uruchomienia skryptu w celu hostowania naszego interfejsu API RESTful na platformie Azure. Skrypt wykonuje następujące kroki:

  • Utworzenie planu usługi Azure App Service w warstwie Bezpłatna.
  • Tworzy internetowy interfejs API w usłudze aplikacja systemu Azure skonfigurowany do wdrożenia usługi Git z lokalnego repozytorium.
  • Ustawia poświadczenia wdrożenia na poziomie konta dla naszej aplikacji.
  • Skonfigurowanie usługi Git lokalnie.
  • Wdraża nasz internetowy interfejs API w naszym wystąpieniu usługi App Service.

  1. Zaloguj się w witrynie Azure Portal.

  2. Na pasku zadań platformy Azure wybierz ikonę usługi Cloud Shell, aby otworzyć usługę Azure Cloud Shell.

    Zrzut ekranu przedstawiający ikonę usługi Cloud Shell na pasku zadań.

  3. Uruchom następujące git polecenie w usłudze Cloud Shell, aby sklonować repozytorium GitHub i pobrać kod źródłowy naszej aplikacji.

    git clone https://github.com/MicrosoftDocs/mslearn-publish-manage-apis-with-azure-api-management.git

  4. Po zakończeniu operacji otwórz folder lokalnego repozytorium i wyświetl jego zawartość, uruchamiając następujące polecenia.

    cd mslearn-publish-manage-apis-with-azure-api-management
ls -l

    Jednym z plików jest setup.sh. Jak sugeruje jej nazwa, jest to skrypt, który uruchamiamy, aby skonfigurować nasz testowy interfejs API.

  5. Uruchom ten skrypt, wprowadzając następujące polecenie. Generuje publiczną aplikację internetową, która uwidacznia interfejs OpenAPI.

    bash setup.sh

    Wykonywanie skryptu zajmie około minuty. Podczas wdrażania wszystkie zależności potrzebne do uruchomienia aplikacji są automatycznie instalowane w zdalnej usłudze App Service. Dane wyjściowe zawierają listę wszystkich operacji. Po zakończeniu działania skryptu dwa ostatnie wiersze to adresy URL używane do testowania wdrożenia aplikacji.

  6. Aby przetestować, czy nasza aplikacja została wdrożona prawidłowo, skopiuj pierwszy adres URL (adres URL programu Swagger) z usługi Cloud Shell i wklej go do nowej karty przeglądarki.

    Przeglądarka powinna wyświetlić interfejs użytkownika struktury Swagger dla naszej aplikacji i zadeklarować następujące punkty końcowe RESTful:

    • usługa api/inventory generuje listę produktów i liczbę w magazynie.
    • funkcja api/inventory/{productid} zwraca liczbę w magazynie dla określonego identyfikatora produktu (liczby całkowitej).
    • usługa api/Products generuje listę produktów.
    • funkcja api/Products/{productid} zwraca szczegóły określonego identyfikatora produktu.

    Przegląd usługi API Management.

  7. Na koniec skopiuj drugi adres URL (adres URL JSON programu Swagger) z danych wyjściowych usługi Cloud Shell i zapisz go gdzieś, na przykład Notatnik. Ten adres URL jest potrzebny w następnym ćwiczeniu.

Wdrażanie bramy interfejsów API

Ostatnim zadaniem w tym ćwiczeniu jest utworzenie bramy interfejsu API w witrynie Azure Portal. W następnym ćwiczeniu użyjesz tej bramy do opublikowania interfejsu API.

  1. Zaloguj się w witrynie Azure Portal.

  2. W usługach platformy Azure lub na stronie głównej wybierz pozycję Utwórz zasób. Zostanie wyświetlone okienko Tworzenie zasobu .

  3. W menu zasobów wybierz pozycję Integracja, a w wynikach wybierz pozycję API Management. Zostanie wyświetlone okienko Tworzenie usługi API Management.

  4. Na karcie Podstawy wprowadź następujące wartości dla każdego ustawienia.

    Ustawienie Wartość
    Szczegóły projektu
    Subskrypcja Wybierz subskrypcję.
    Grupa zasobów Wybierz nową lub istniejącą grupę zasobów. Grupa zasobów to logiczny kontener, który przechowuje powiązane zasoby dla rozwiązania platformy Azure.
    Szczegóły wystąpienia
    Region (Region) Wybierz dostępny region.
    Nazwa zasobu apim-NorthWindShoes<random number>, zastępując random number ciąg własną serią liczb, aby upewnić się, że nazwa jest globalnie unikatowa.
    Nazwa organizacji NorthWindShoes. Nazwa organizacji do użycia w portalu dla deweloperów i powiadomienia e-mail. (Portal deweloperów i powiadomienia nie są dostępne we wszystkich warstwach usług).
    Wiadomość e-mail administratora Adres e-mail do odbierania wszystkich powiadomień systemowych.
    Warstwa cenowa Consumption

    Uwaga

    Warstwa Zużycie zapewnia szybkie wdrożenie do testowania i ma model cen płatności za użycie. Ogólne środowisko usługi API Management jest podobne do innych warstw cenowych.

  5. Wybierz pozycję Przejrzyj i utwórz , aby zweryfikować ustawienia.

  6. Po zakończeniu walidacji wybierz pozycję Utwórz. Wdrożenie może potrwać kilka minut.

  7. Po zakończeniu wdrażania wystąpienie usługi API Management jest wyświetlane w zasobach platformy Azure. Wybierz pozycję Przejdź do zasobu , aby wyświetlić okienko dla usługi API Management.