Udostępnij przez

Dostosuj portal Centrum API

W tym artykule opisano ustawienia, które można dostosować w portalu Centrum interfejsu API (wersja zapoznawcza). Portal Centrum interfejsów API to zarządzana przez platformę Azure witryna internetowa, która umożliwia deweloperom i innym uczestnikom projektu w organizacji odnajdywanie interfejsów API w centrum interfejsu API.

Aby skonfigurować portal Centrum interfejsów API do początkowego użycia i logowania, zobacz Konfigurowanie portalu centrum interfejsów API.

Uwaga / Notatka

Portal Centrum interfejsów API jest obecnie w wersji zapoznawczej.

Strona ustawień portalu

Skonfiguruj ustawienia portalu centrum interfejsu API w witrynie Azure Portal. Aby uzyskać dostęp do strony ustawień:

  1. Przejdź do centrum interfejsu API w witrynie Azure Portal.
  2. W obszarze Portal centrum interfejsów API wybierz pozycję Ustawienia.
  3. Kliknij karty, aby wyświetlić i dostosować ustawienia.
  4. Wybierz pozycję Zapisz i opublikuj , aby zastosować zmiany.

Zrzut ekranu przedstawiający ustawienia portalu centrum interfejsu API w witrynie Azure Portal.

Ważne

Wybierz pozycję Zapisz i opublikuj za każdym razem, gdy wprowadzisz zmiany w ustawieniach. Dopóki nie opublikujesz, zmiany nie będą widoczne w portalu Centrum interfejsu API.

Profil witryny

Na karcie Profil witryny opcjonalnie podaj nazwę niestandardową wyświetlaną na górnym pasku opublikowanego portalu.

Zrzut ekranu nazwy niestandardowej w portalu API Center.

Widoczność interfejsu API

Na karcie Widoczność interfejsu API możesz kontrolować, które interfejsy API są wykrywalne (widoczne) dla użytkowników portalu usługi API Center. Ustawienia widoczności dotyczą wszystkich użytkowników portalu Centrum interfejsów API.

Portal centrum API używa interfejsu API płaszczyzny danych centrum API platformy Azure do pobierania i wyświetlania interfejsów API w Twoim centrum API. Domyślnie pokazuje wszystkie interfejsy API dla zalogowanych użytkowników z uprawnieniami Azure RBAC.

Aby uwidocznić tylko określone interfejsy API, dodaj warunki filtrowania dla interfejsów API na podstawie wbudowanych właściwości. Na przykład wybierz wyświetlanie interfejsów API tylko niektórych typów (takich jak REST lub GraphQL) lub na podstawie określonych formatów specyfikacji (takich jak OpenAPI).

Zrzut ekranu przedstawiający dodawanie warunków widoczności interfejsu API w portalu.

Dostęp anonimowy

Na karcie Widoczność interfejsu API możesz opcjonalnie włączyć anonimowy dostęp do odczytu do interfejsu API płaszczyzny danych Centrum API Azure, co umożliwia użytkownikom bez uwierzytelnienia odkrywanie spisu interfejsów API poprzez bezpośrednie wywołania API. Na przykład włącz to ustawienie, aby interfejsy API mogły być odnajdywane przez nieuwierzytelnionych użytkowników, gdy samodzielnie hostujesz portal Centrum API.

Ostrzeżenie

Podczas włączania dostępu anonimowego należy zadbać, aby nie ujawniać poufnych informacji w definicjach interfejsu API lub ustawieniach.

Jeśli ta opcja jest włączona na karcie Wyszukiwanie semantyczne , portal Centrum interfejsu API uzupełnia podstawowe wyszukiwanie oparte na nazwach interfejsów API przy użyciu wyszukiwania semantycznego wspomaganego przez sztuczną inteligencję utworzonego na podstawie nazw interfejsów API, opisów i opcjonalnie niestandardowych metadanych. Wyszukiwanie semantyczne jest dostępne tylko w planie standardowym .

Użytkownicy mogą wyszukiwać interfejsy API przy użyciu zapytań języka naturalnego, co ułatwia znajdowanie interfejsów API na podstawie ich intencji. Jeśli na przykład deweloper wyszukuje ciąg "Potrzebuję interfejsu API do zarządzania zapasami", portal może sugerować odpowiednie interfejsy API, nawet jeśli nazwy interfejsów API lub opisy nie zawierają tych konkretnych słów.

Wskazówka

W przypadku korzystania z bezpłatnego planu usługi Azure API Center możesz łatwo uaktualnićplan standardowy , aby włączyć pełne funkcje usługi, w tym wyszukiwanie semantyczne w portalu Centrum interfejsów API.

Aby użyć wyszukiwania wspomaganego przez sztuczną inteligencję po zalogowaniu się do portalu Centrum interfejsu API, kliknij pole wyszukiwania, wybierz pozycję Wyszukaj przy użyciu sztucznej inteligencji i wprowadź zapytanie.

Zrzut ekranu przedstawiający wyniki wyszukiwania semantycznego w portalu centrum interfejsu API.

Metadane niestandardowe

Na karcie Metadane opcjonalnie wybierz właściwości niestandardowych metadanych , które chcesz uwidocznić w szczegółach interfejsu API i wyszukiwaniu semantycznym.

Włącz dostęp do konsoli testowej dla API

Możesz skonfigurować ustawienia użytkownika w celu szczegółowego autoryzowania dostępu do API i ich określonych wersji w centrum API. Na przykład skonfiguruj niektóre wersje interfejsu API do używania kluczy interfejsu API do uwierzytelniania i utwórz zasady dostępu, które zezwalają tylko określonym użytkownikom na uwierzytelnianie przy użyciu tych kluczy.

Zasady dostępu dotyczą również funkcji "Wypróbuj ten interfejs API" dla interfejsów API w portalu Centrum interfejsów API, zapewniając, że tylko użytkownicy portalu z odpowiednimi zasadami dostępu mogą używać konsoli testowej dla tych wersji interfejsu API. Dowiedz się więcej o autoryzowaniu dostępu do interfejsów API

Treści powiązane

  • Last updated on