Udostępnij za pośrednictwem

Włączanie i wyświetlanie widoku portalu Centrum interfejsów API platformy Azure — rozszerzenie programu VS Code

W tym artykule pokazano, jak zapewnić deweloperom przedsiębiorstwa dostęp do widoku portalu Centrum interfejsów API platformy Azure w rozszerzeniu programu Visual Studio Code dla centrum interfejsu API platformy Azure. Korzystając z widoku portalu, deweloperzy mogą odnajdywać interfejsy API w centrum interfejsów API platformy Azure, wyświetlać definicje interfejsów API i opcjonalnie generować klientów interfejsu API, gdy nie mają dostępu do zarządzania samym centrum interfejsów API lub dodawać interfejsy API do spisu. Dostęp do widoku portalu Centrum interfejsu API jest zarządzany przy użyciu identyfikatora Entra firmy Microsoft i kontroli dostępu opartej na rolach platformy Azure.

Wskazówka

Rozszerzenie programu Visual Studio Code udostępnia więcej funkcji dla deweloperów interfejsu API, którzy mają uprawnienia do zarządzania centrum interfejsu API platformy Azure. Na przykład deweloperzy API mogą rejestrować API w centrum API bezpośrednio lub za pomocą potoków CI/CD. Dowiedz się więcej

Wymagania wstępne

Dla administratorów centrum interfejsu API

  • Centrum API w subskrypcji Azure. Jeśli jeszcze go nie utworzono, zobacz Szybki start: tworzenie centrum interfejsu API.

  • Uprawnienia do tworzenia rejestracji aplikacji w dzierżawie usługi Microsoft Entra skojarzonej z subskrypcją platformy Azure oraz uprawnienia do udzielania dostępu do danych w centrum API.

Dla deweloperów aplikacji

Następujące rozszerzenia programu Visual Studio Code są opcjonalne:

  • Rozszerzenie Microsoft Kiota — do generowania klientów interfejsu API
  • GitHub Copilot i GitHub Copilot Chat, udostępniane z dostępem do gitHub Copilot — do korzystania z narzędzi modelu językowego w trybie agenta do odnajdywania interfejsów API

Procedura włączania dostępu do widoku portalu Centrum interfejsu API dla administratorów centrum interfejsu API

W poniższych sekcjach przedstawiono kroki dla administratorów centrum interfejsu API, aby umożliwić deweloperom przedsiębiorstwa dostęp do widoku portalu Centrum interfejsów API.

Tworzenie rejestracji aplikacji Microsoft Entra

Najpierw skonfiguruj rejestrację aplikacji w dzierżawie Microsoft Entra ID. Rejestracja aplikacji umożliwia portalowi Centrum interfejsów API uzyskiwanie dostępu do danych z centrum interfejsu API w imieniu zalogowanego użytkownika.

Centrum interfejsu API może automatycznie skonfigurować rejestrację aplikacji lub ręcznie utworzyć rejestrację aplikacji.

Automatyczne konfigurowanie rejestracji aplikacji

Aby automatycznie skonfigurować rejestrację aplikacji, wykonaj następujące kroki:

  1. W witrynie Azure portal przejdź do centrum API.
  2. W menu po lewej stronie wybierz pozycjęUstawienia portalu >Centrum interfejsu API.
  3. Na karcie Identity provider (Dostawca tożsamości ) wybierz pozycję Start set up (Uruchom konfigurację).
  4. Wybierz pozycję Zapisz i opublikuj.

Ręczne konfigurowanie rejestracji aplikacji

Jeśli chcesz ręcznie utworzyć rejestrację aplikacji, wykonaj następujące kroki:

  1. W witrynie Azure Portal przejdź dopozycji Rejestracje aplikacji>.

  2. Wybierz pozycję + Nowa rejestracja.

  3. Na stronie Rejestrowanie aplikacji ustaw następujące wartości:

    1. Ustaw nazwę na zrozumiałą nazwę, taką jak api-center-portal
    2. W obszarze Obsługiwane typy kont wybierz Konta w tym katalogu organizacyjnym (pojedyncza dzierżawa).
    3. W polu URI przekierowania wybierz opcję Aplikacja jednostronicowa (SPA) i ustaw URI. Wprowadź identyfikator URI wdrożenia portalu Centrum API w następującym formacie: https://<service-name>.portal.<location>.azure-api-center.ms. Zastąp <service name> i <location> nazwą centrum interfejsu API oraz lokalizacją, w której jest wdrożone, przykład: https://myapicenter.portal.eastus.azure-api-center.ms.
    4. Wybierz pozycję Zarejestruj.

Skonfiguruj dodatkowe identyfikatory URI przekierowania dla rozszerzenia VS Code

Podczas włączania widoku portalu Centrum interfejsu API w rozszerzeniu programu Visual Studio Code dla centrum interfejsu API skonfiguruj również następujące identyfikatory URI przekierowania w rejestracji aplikacji:

  1. W witrynie Azure Portal przejdź do rejestracji aplikacji.

  2. Na stronie Zarządzanie>uwierzytelnianiem wybierz pozycję Dodaj platformę i wybierz pozycję Aplikacje mobilne i klasyczne.

  3. Skonfiguruj następujące trzy niestandardowe adresy URI przekierowań:
    https://vscode.dev/redirect
    http://localhost
    ms-appx-web://Microsoft.AAD.BrokerPlugin/<application-client-id>

    Zastąp <application-client-id> element identyfikatorem aplikacji (klienta) tej aplikacji. Tę wartość można znaleźć na stronie Przegląd rejestracji aplikacji.

Włączanie logowania do widoku portalu Centrum interfejsów API według użytkowników i grup firmy Microsoft Entra

Deweloperzy w przedsiębiorstwie muszą zalogować się przy użyciu konta Microsoft, aby wyświetlić widok portalu Centrum interfejsów API dla centrum interfejsu API. W razie potrzeby dodaj lub zaproś deweloperów do dzierżawy Microsoft Entra.

Aby włączyć logowanie się, przypisz rolę Czytelnik danych centrum interfejsu API platformy Azure do użytkowników lub grup w organizacji, w zakresie działalności centrum interfejsu API.

Ważne

Domyślnie ty i inni administratorzy API Center nie mają dostępu do API w portalu API Center. Pamiętaj, aby przypisać rolę Czytelnik danych Centrum interfejsu API platformy Azure do siebie i innych administratorów.

Aby uzyskać szczegółowe wymagania wstępne i kroki przypisywania roli do użytkowników i grup, zobacz Przypisywanie ról platformy Azure przy użyciu witryny Azure Portal. Wykonaj krótkie kroki:

  1. W witrynie Azure portal przejdź do centrum API.
  2. W menu po lewej stronie wybierz pozycję Kontrola dostępu (IAM)>+ Dodaj przypisanie roli.
  3. W okienku Dodawanie przypisania roli ustaw następujące wartości:
    1. Na stronie Rola wyszukaj i wybierz Czytelnik danych centrum interfejsów API platformy Azure. Wybierz Dalej.
    2. Na stronie Członkowie w sekcji Przypisz dostęp do, wybierz pozycję Użytkownik, grupa lub jednostka usługi>, a następnie kliknij + Wybierz członków.
    3. Na stronie Wybieranie członków wyszukaj i wybierz użytkowników lub grupy, do których ma zostać przypisana rola. Kliknij pozycję Wybierz, a następnie pozycję Dalej.
    4. Przejrzyj przypisanie roli i wybierz Przejrzyj i przypisz.

Uwaga

Aby usprawnić konfigurację dostępu dla nowych użytkowników, zalecamy przypisanie roli do grupy Microsoft Entra i skonfigurowanie reguły członkostwa w grupie dynamicznej. Aby dowiedzieć się więcej, zobacz Tworzenie lub aktualizowanie grupy dynamicznej w identyfikatorze Entra firmy Microsoft.

Po skonfigurowaniu dostępu do portalu, użytkownicy mogą logować się do niego i wyświetlać interfejsy API w centrum API.

Uwaga

Pierwszy użytkownik, który zaloguje się do portalu, jest monitowany o wyrażenie zgody na uprawnienia żądane przez rejestrację aplikacji w portalu centrum interfejsu API. Następnie inni skonfigurowani użytkownicy nie są monitowani o wyrażenie zgody.

Kroki umożliwiające deweloperom przedsiębiorstwa uzyskiwanie dostępu do widoku portalu Centrum interfejsów API

Deweloperzy mogą wykonać następujące kroki, aby nawiązać połączenie i zalogować się do widoku portalu Centrum interfejsu API przy użyciu rozszerzenia programu Visual Studio Code. Ustawienia umożliwiające nawiązanie połączenia z centrum interfejsu API muszą być udostępniane przez administratora centrum interfejsu API. Po nawiązaniu połączenia deweloperzy mogą odkrywać i korzystać z interfejsów API w centrum API.

Połącz z centrum API

  1. W programie Visual Studio Code na pasku działań po lewej stronie wybierz pozycję Centrum interfejsu API.

    Zrzut ekranu przedstawiający ikonę Centrum interfejsu API na pasku działań.

  2. Użyj skrótu klawiaturowego Ctrl+Shift+P , aby otworzyć paletę poleceń. Wpisz Centrum interfejsów API platformy Azure: Połącz się z Centrum interfejsów API i naciśnij Enter.

  3. Odpowiedz na monity, aby wprowadzić następujące informacje.

    1. Adres URL środowiska uruchomieniowego twojego centrum API w formacie <service name>.data.<region>.azure-apicenter.ms (nie dodawaj prefiksu https://). Przykład: contoso-apic.data.eastus.azure-apicenter.ms. Ten adres URL środowiska uruchomieniowego jest wyświetlany na stronie Przegląd centrum API w widoku portalu Azure.

    2. Identyfikator aplikacji (klienta) z rejestracji aplikacji skonfigurowanej przez administratora w poprzedniej sekcji.

    3. Identyfikator katalogu (dzierżawy) z rejestracji aplikacji, którą skonfigurował administrator w poprzedniej sekcji.

    Wskazówka

    Administrator centrum interfejsu API musi podać powyższe szczegóły połączenia deweloperom lub udostępnić bezpośredni link w następującym formacie:
    vscode://apidev.azure-api-center?clientId=<Client ID>&tenantId=<tenant ID>&runtimeUrl=<service-name>.data.<region>.azure-apicenter.ms

    Po nawiązaniu połączenia z centrum API, nazwa tego centrum pojawi się w widoku portalu Centrum API.

  4. Aby wyświetlić interfejsy API w centrum API, pod nazwą centrum API wybierz opcję Zaloguj się do Azure. Można się zalogować za pomocą konta Microsoft, które ma przypisaną rolę Czytelnik danych centrum API platformy Azure w centrum API.

    Zrzut ekranu pokazujący widok portalu Centrum API w rozszerzeniu Centrum API.

  5. Po zalogowaniu wybierz pozycję Interfejsy API , aby wyświetlić listę interfejsów API w centrum interfejsu API. Rozwiń interfejs API, aby eksplorować jego wersje i definicje.

    Zrzut ekranu przedstawiający definicje interfejsu API w rozszerzeniu API Center.

  6. Powtórz powyższe kroki, aby nawiązać połączenie z większą liczbą centrów API, jeżeli dostęp został skonfigurowany.

Odkrywaj i korzystaj z interfejsów API w widoku portalu Centrum API

Widok portalu Centrum interfejsu API ułatwia deweloperom przedsiębiorstwa odnajdywanie szczegółów interfejsu API i rozpoczynanie opracowywania klienta interfejsu API. Deweloperzy mogą uzyskać dostęp do następujących funkcji, klikając prawym przyciskiem myszy definicję interfejsu API w widoku portalu Centrum interfejsów API:

  • Eksportowanie dokumentu specyfikacji interfejsu API — eksportowanie specyfikacji interfejsu API z definicji, a następnie pobieranie jej jako pliku
  • Generowanie klienta interfejsu API — użyj rozszerzenia Microsoft Kiota, aby wygenerować klienta interfejsu API dla swojego ulubionego języka
  • Generowanie Markdown - Tworzenie dokumentacji interfejsu API w formacie Markdown
  • Dokumentacja interfejsu OpenAPI — wyświetl dokumentację definicji interfejsu API i spróbuj wykonać operacje w interfejsie użytkownika struktury Swagger (dostępne tylko dla definicji interfejsu OpenAPI)

Korzystanie z narzędzi modelu językowego

Programiści z dostępem do portalu Centrum API mogą dodawać narzędzia modelu językowego Centrum API do użycia w trybie Agenta Copilot w usłudze GitHub. Dowiedz się więcej o korzystaniu z narzędzi w trybie agenta.

Narzędzia Centrum API mogą być używane w trybie agenta, aby ułatwić wyszukiwanie API i jego wersji, definicji i specyfikacji, wdrożeń i nie tylko przy użyciu poleceń w języku naturalnym.

Aby dodać narzędzia trybu językowego centrum API i korzystać z nich w trybie agenta GitHub Copilot:

  1. Połącz się z centrum interfejsu API zgodnie z opisem w poprzedniej sekcji.

  2. Otwórz aplikację GitHub Copilot Chat w programie Visual Studio Code.

  3. Ustaw tryb czatu GitHub Copilot Chat na Agent.

  4. Wybierz ikonę Narzędzia w oknie czatu.

    Zrzut ekranu przedstawiający okno czatu Copilot usługi GitHub w programie Visual Studio Code.

  5. Wybierz jedno lub więcej narzędzi Centrum API, które mają być dostępne na czacie.

    Zrzut ekranu przedstawiający wybieranie narzędzi centrum interfejsu API w programie Visual Studio Code.

  6. Wprowadź monit w oknie czatu, aby użyć dostępnych narzędzi. Przykład:

    Find potential MCP servers for a project I'm working on. I need the deployment URLs from my API center of any MCP servers that can run code snippets.

  7. Przejrzyj odpowiedzi z usługi GitHub Copilot Chat. Kontynuuj konwersację, aby uściślić wyniki lub zadawać pytania.

Rozwiązywanie problemów

Nie można zalogować się na platformie Azure

Jeśli użytkownicy, którym przypisano rolę Czytelnik danych centrum interfejsu API platformy Azure , nie mogą ukończyć przepływu logowania po wybraniu pozycji Zaloguj się do platformy Azure w widoku portalu Centrum interfejsu API, może wystąpić problem z konfiguracją połączenia.

Sprawdź ustawienia w rejestracji aplikacji skonfigurowanej w usłudze Microsoft Entra ID. Potwierdź wartości identyfikatora aplikacji (klienta) oraz identyfikatora katalogu (dzierżawy) w rejestracji aplikacji, a także adres URL czasu działania centrum API. Następnie ponownie skonfiguruj połączenie z centrum interfejsu API.

Powiązana zawartość