Skonfiguruj portal Centrum API

W tym artykule pokazano, jak skonfigurować portal Centrum interfejsów API (wersja zapoznawcza), zarządzaną przez platformę Azure witrynę internetową, której deweloperzy i inni uczestnicy projektu w organizacji używają do odnajdywania interfejsów API w centrum interfejsu API. Zalogowani użytkownicy mogą przeglądać i filtrować interfejsy API oraz wyświetlać szczegóły interfejsu API, takie jak definicje interfejsu API i dokumentacja. Dostęp użytkowników do informacji o interfejsie API jest oparty na identyfikatorze Entra firmy Microsoft i kontroli dostępu opartej na rolach na platformie Azure.

Wymagania wstępne

• 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.

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. Na karcie Szybka konfiguracja wybierz pozycję Zapisz i opublikuj.

Jeśli chcesz później uzyskać dostęp do rejestracji aplikacji, możesz ją znaleźć w portalu w obszarze Rejestracje aplikacji. Aplikacja ma następujący format: <api-center-name-apic-aad>.

Ręczne konfigurowanie rejestracji aplikacji

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

1. W wAzure Portal, przejdź do Microsoft Entra ID>Zarządzanie>rejestracjami 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. Pod Obsługiwane typy kont, wybierz opcję Konta tylko w tym katalogu organizacyjnym (<nazwa> katalogu — tylko dla jednego najemcy).
   3. W polu URI przekierowania wybierz opcję Aplikacja jednostronicowa (SPA) i ustaw URI. Wprowadź identyfikator URI wdrożenia portalu API Center w następującym formacie: https://<service-name>.portal.<location>.azure-apicenter.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-apicenter.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.

Konfiguracja i publikacja portalu Centrum API

Po utworzeniu rejestracji aplikacji portalu API Center można dostosować ustawienia i opublikować portal centrum API. Wykonaj następujące kroki w witrynie Azure Portal.

1. W witrynie Azure portal przejdź do centrum API.

2. W menu po lewej stronie w obszarze Portal centrum interfejsów API wybierz pozycję Ustawienia.

   

3. Jeśli rejestracja aplikacji zostanie skonfigurowana ręcznie, na karcie Dostawca tożsamości wybierz pozycję Rozpocznij konfigurowanie. Jeśli użyto szybkiej konfiguracji, ten krok jest już ukończony i możesz kontynuować ustawienia na innych kartach.

   1. Na karcie Manual w polu Client ID, wprowadź identyfikator aplikacji (klienta) z rejestracji aplikacji utworzonej w poprzedniej sekcji.
   2. Upewnij się, że identyfikator URI przekierowania jest wartością skonfigurowaną w ustawieniach rejestracji aplikacji.
   3. Wybierz pozycję Zapisz i opublikuj.

4. Na pozostałych kartach dostosuj opcjonalnie ustawienia swojego portalu Centrum API. Aby uzyskać informacje na temat ustawień, zobacz Dostosowywanie portalu centrum interfejsu API.

5. Wybierz pozycję Zapisz i opublikuj.

Uzyskiwanie dostępu do portalu

Po opublikowaniu możesz uzyskać dostęp do portalu Centrum interfejsu API w przeglądarce.

• Na stronie Ustawienia portalu wybierz pozycję Wyświetl portal Centrum interfejsu API , aby otworzyć portal na nowej karcie.
• Możesz też wprowadzić następujący adres URL w przeglądarce, zastępując <service-name> nazwą centrum interfejsu API oraz <location> lokalizacją, w której został wdrożony.
  https://<service-name>.portal.<location>.azure-apicenter.ms

Domyślnie strona główna portalu jest dostępna publicznie, ale wymaga logowania w celu uzyskania dostępu do interfejsów API. Aby uzyskać szczegółowe informacje na temat konfigurowania dostępu użytkownika do portalu, zobacz Włączanie logowania do portalu przez użytkowników i grupy firmy Microsoft .

Włącz logowanie do portalu przez użytkowników i grupy Microsoft Entra

Aby włączyć logowanie do portalu Centrum API w celu uzyskania dostępu do API, przypisz rolę Czytelnik danych centrum API platformy Azure do użytkowników lub grup w Twojej organizacji, do Twojego centrum API.

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 opcję Przegląd i przypisz.

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

Odkrywanie i użytkowanie API w portalu Centrum API

Portal Centrum interfejsów API obsługuje i usprawnia pracę deweloperów korzystających z interfejsów API i tworzących je w organizacji. Zalogowani użytkownicy mogą wykonywać następujące czynności:

• Wyszukiwanie interfejsów API według nazwy lub korzystanie z wyszukiwania semantycznego wspomaganego przez sztuczną inteligencję

• Filtrowanie interfejsów API według typu lub etapu cyklu życia

• Wyświetlanie szczegółów i definicji interfejsu API , w tym punktów końcowych, metod, parametrów i formatów odpowiedzi

• Pobieranie definicji interfejsu API na komputer lokalny lub otwieranie ich w programie Visual Studio Code

• Wypróbuj interfejsy API obsługujące uwierzytelnianie klucza interfejsu API lub autoryzację protokołu OAuth 2.0

Portale API Management i centra interfejsów API

Usługi Azure API Management i Azure API Center zapewniają portale dla deweloperów w celu odnajdywania i korzystania z interfejsów API:

• Portal deweloperów usługi API Management umożliwia użytkownikom znajdowanie zarządzanych interfejsów API (w tym grup interfejsów API zarządzanych jako produkty), dowiedz się, jak ich używać, żądać dostępu i testować.
• Portal Centrum interfejsów API (wersja zapoznawcza) to portal wielobramkowy, w którym użytkownicy mogą odnajdywać i filtrować pełną listę interfejsów API organizacji.

Chociaż oba portale współdzielą niektóre funkcje, mają one również różne różnice. W poniższej tabeli porównaliśmy bieżące możliwości, aby określić, który portal ma być używany. Niektóre organizacje mogą preferować jeden portal, podczas gdy inne mogą potrzebować obu.

¹ Portal Centrum interfejsów API może zawierać wszystkie interfejsy API w organizacji, w tym te zarządzane w usłudze Azure API Management i innych platformach, a także niezarządzane interfejsy API i interfejsy API w ramach programowania.

Powiązana zawartość

• Dostosowywanie portalu centrum interfejsów API
• Włączanie i wyświetlanie portalu Centrum interfejsów API platformy Azure w programie Visual Studio Code
• Samodzielne hostowanie portalu Centrum API