Udostępnij za pomocą

Samouczek: dodawanie środowisk i wdrożeń dla interfejsów API

W tym samouczku wyjaśniono, jak rozszerzyć inwentarz w centrum API, dodając informacje o środowiskach API i wdrożeniach.

  • Środowisko reprezentuje lokalizację, w której można wdrożyć środowisko uruchomieniowe interfejsu API, na przykład platformę API Management.
  • Wdrożenie to lokalizacja lub adres, w którym użytkownicy mogą uzyskiwać dostęp do interfejsu API.

Aby uzyskać więcej informacji na temat interfejsów API, wdrożeń i innych jednostek, które można spisać w centrum interfejsów API platformy Azure, zobacz Kluczowe pojęcia.

Z tego samouczka dowiesz się, jak używać portalu do wykonywania następujących problemów:

  • Dodawanie informacji o środowiskach interfejsu API
  • Dodawanie informacji o wdrożeniach interfejsu API

Wymagania wstępne

Dodaj środowisko

Użyj centrum interfejsu API, aby śledzić rzeczywiste środowiska interfejsu API. Możesz na przykład użyć usługi Azure API Management lub innego rozwiązania do rozpowszechniania, zabezpieczania i monitorowania niektórych interfejsów API. Możesz też bezpośrednio obsługiwać niektóre interfejsy API przy użyciu usługi obliczeniowej lub klastra Kubernetes.

W tym miejscu dodasz informacje o fikcyjnym środowisku usługi Azure API Management do centrum interfejsu API. Jeśli wolisz, dodaj informacje o jednym z istniejących środowisk. Skonfiguruj zarówno wbudowane metadane, jak i wszelkie niestandardowe metadane zdefiniowane w poprzednim samouczku.

  1. Zaloguj się do witryny Azure Portal, a następnie przejdź do centrum interfejsu API.

  2. W menu paska bocznego w obszarze Zasoby wybierz pozycję Środowiska>+ Nowe środowisko.

  3. Na stronie Nowe środowisko dodaj następujące informacje. Jeśli wcześniej zdefiniowano niestandardową linię biznesową metadanych lub inne metadane przypisane do środowisk, zobaczysz je w dolnej części strony.

    Setting Wartość Description
    Tytuł środowiska Wprowadź my testing (Moje testowanie). Nazwa wybrana dla środowiska
    Identyfikator Po wprowadzeniu poprzedniego tytułu centrum interfejsu API platformy Azure generuje ten identyfikator, który można zastąpić. Nazwa zasobu platformy Azure dla środowiska
    Typ środowiska Wybierz pozycję Testowanie z listy rozwijanej. Typ środowiska dla interfejsów API
    Opis Możesz również wprowadzić opis. Opis środowiska
    Server
    Typ Opcjonalnie wybierz pozycję Azure API Management z listy rozwijanej. Typ używanego rozwiązania API Management
    Adres URL portalu zarządzania Opcjonalnie wprowadź adres URL interfejsu zarządzania, na przykład https://admin.contoso.com Adres URL interfejsu zarządzania dla środowiska
    dołączanie
    Adres URL portalu programowania Opcjonalnie wprowadź adres URL portalu dla deweloperów, taki jak https://developer.contoso.com Adres URL interfejsu do onboardingu deweloperów w środowisku
    Instrukcje Opcjonalnie wybierz pozycję Edytuj i wprowadź instrukcje dołączania w standardowym języku Markdown. Instrukcje wdrażania do interfejsów API z danego środowiska
    Działalność biznesowa W przypadku dodania tych niestandardowych metadanych opcjonalnie dokonaj wyboru z listy rozwijanej, takiej jak IT. Niestandardowe metadane identyfikujące jednostkę biznesową zarządzającą środowiskiem

    Zrzut ekranu przedstawiający dodawanie środowiska interfejsu API w portalu.

  4. Wybierz Utwórz. Środowisko jest wyświetlane na liście środowisk.

Dodawanie wdrożenia

Centrum interfejsów API może również ułatwić katalogowanie wdrożeń interfejsów API oraz środowisk uruchomieniowych, w których są wdrażane śledzone interfejsy API.

W tym miejscu dodasz wdrożenie, kojarząc jeden z interfejsów API ze środowiskiem utworzonym w poprzedniej sekcji. Konfigurowane są zarówno wbudowane metadane, jak i wszelkie zdefiniowane przez Ciebie metadane niestandardowe.

  1. W portalu Azure przejdź do centrum interfejsów API.

  2. W menu paska bocznego w obszarze Zasoby wybierz pozycję Interfejsy API.

  3. Wybierz interfejs API, na przykład interfejs API konferencji.

  4. Na stronie Interfejs API konferencji w obszarze Szczegóły wybierz pozycję >.

  5. Na stronie Dodawanie wdrożenia dodaj następujące informacje. Jeśli wcześniej zdefiniowano niestandardowe metadane branżowe lub inne metadane przypisane do środowisk, można je zobaczyć w dolnej części strony.

    Setting Wartość Description
    Tytuł Wprowadź wartość Wdrożenie w wersji 1. Nazwa, którą wybierzesz dla wdrożenia
    Identyfikator Po wprowadzeniu poprzedniego tytułu centrum interfejsu API platformy Azure generuje ten identyfikator, który można zastąpić. Nazwa zasobu platformy Azure dla wdrożenia
    Opis Możesz również wprowadzić opis. Opis wdrożenia
    Środowisko Wybierz z listy rozwijanej, np . Moje testowanie lub opcjonalnie wybierz pozycję Utwórz nową. Nowe lub istniejące środowisko, w którym wdrożono wersję interfejsu API
    Definicja Wybierz lub dodaj plik definicji dla wersji interfejsu API konferencji. Plik definicji interfejsu API
    Adres URL środowiska uruchomieniowego Wprowadź podstawowy adres URL, na przykład https://api.contoso.com. Podstawowy adres URL środowiska wykonawczego dla interfejsu API w danym środowisku
    Działalność biznesowa W przypadku dodania tych niestandardowych metadanych opcjonalnie dokonaj wyboru z listy rozwijanej, takiej jak IT. Niestandardowe metadane identyfikujące jednostkę biznesową zarządzającą interfejsami API w środowisku

    Zrzut ekranu przedstawiający dodawanie wdrożenia interfejsu API w portalu.

  6. Wybierz Utwórz. Wdrożenie zostanie wyświetlone na liście wdrożeń.

W tym samouczku przedstawiono sposób używania portalu do wykonywania następujących problemów:

  • Dodawanie informacji o środowiskach interfejsu API
  • Dodawanie informacji o wdrożeniach interfejsu API

Treści powiązane

  • Last updated on