Portal deweloperów usługi API Management — często zadawane pytania

Artykuł
04/13/2024

Co zrobić, jeśli potrzebuję funkcji, które nie są obsługiwane w portalu?

Do wyboru są następujące opcje:

W przypadku małych dostosowań użyj wbudowanego widżetu, aby dodać niestandardowy kod HTML. Obecnie niestandardowy widżet kodu HTML nie jest dostępny w warstwach 2 usługi API Management.
W przypadku większych dostosowań utwórz i przekaż niestandardowy widżet do zarządzanego portalu deweloperów. Obecnie niestandardowe widżety nie są dostępne w warstwach 2 usługi API Management.
Samodzielne hostowanie portalu dla deweloperów, tylko wtedy, gdy musisz wprowadzić modyfikacje do rdzenia bazy kodu portalu deweloperów.
Otwórz żądanie funkcji w repozytorium GitHub.

Dowiedz się więcej na temat dostosowywania i rozszerzania funkcjonalności portalu dla deweloperów.

Czy mogę mieć wiele portali deweloperów w jednej usłudze API Management?

Można mieć jeden portal zarządzany i wiele portali hostowanych samodzielnie. Zawartość wszystkich portali jest przechowywana w tej samej usłudze API Management, więc będą identyczne. Jeśli chcesz wyróżnić wygląd i funkcjonalność portalu, możesz samodzielnie hostować je za pomocą własnych niestandardowych widżetów, które dynamicznie dostosowują strony w środowisku uruchomieniowym, na przykład na podstawie adresu URL.

Czy portal obsługuje szablony usługi Azure Resource Manager i/lub czy jest zgodny z zestawem Resource Kit devOps usługi API Management?

L.p.

Czy zawartość portalu jest zapisywana z funkcją tworzenia/przywracania kopii zapasowej w usłudze API Management?

L.p.

Czy muszę włączyć dodatkową łączność z siecią wirtualną dla zależności portalu zarządzanego?

W większości przypadków — nie.

Jeśli usługa API Management znajduje się w wewnętrznej sieci wirtualnej, portal deweloperów jest dostępny tylko z poziomu sieci. Nazwa hosta punktu końcowego zarządzania musi być rozpoznawana jako wewnętrzny adres VIP usługi z komputera używanego do uzyskiwania dostępu do interfejsu administracyjnego portalu. Upewnij się, że punkt końcowy zarządzania jest zarejestrowany w systemie DNS. W przypadku błędnej konfiguracji zostanie wyświetlony błąd: Unable to start the portal. See if settings are specified correctly in the configuration (...).

Jeśli usługa API Management znajduje się w wewnętrznej sieci wirtualnej i uzyskujesz do niej dostęp za pośrednictwem usługi Application Gateway z Internetu, upewnij się, że włączono łączność z portalem deweloperów i punktami końcowymi zarządzania usługi API Management. Może być konieczne wyłączenie reguł zapory aplikacji internetowej. Aby uzyskać więcej informacji, zobacz ten artykuł w dokumentacji.

Przypisano niestandardową domenę usługi API Management, a opublikowany portal nie działa

Po zaktualizowaniu domeny należy ponownie opublikować portal, aby zmiany zaczęły obowiązywać.

Dodano dostawcę tożsamości i nie widzę go w portalu

Po skonfigurowaniu dostawcy tożsamości (na przykład usługi Azure AD, Azure AD B2C) należy ponownie opublikować portal , aby zmiany zaczęły obowiązywać. Upewnij się, że strony portalu deweloperów zawierają widżet przycisków OAuth.

Konfiguruję delegowanie, a portal nie używa go

Po skonfigurowaniu delegowania należy ponownie opublikować portal, aby zmiany zaczęły obowiązywać.

Moje inne zmiany konfiguracji usługi API Management nie zostały rozpropagowane w portalu dla deweloperów

Większość zmian konfiguracji (na przykład sieć wirtualna, logowanie, terminy produktu) wymaga ponownego opublikowania portalu.

Otrzymuję błąd CORS podczas korzystania z konsoli interaktywnej

Konsola interaktywna wysyła żądanie interfejsu API po stronie klienta z przeglądarki. Rozwiąż problem z mechanizmem CORS, dodając zasady CORS do interfejsów API lub konfigurując portal tak, aby używał serwera proxy CORS. Aby uzyskać więcej informacji, zobacz Włączanie mechanizmu CORS dla konsoli interaktywnej w portalu deweloperów usługi API Management.

W przypadku korzystania z niestandardowego widżetu kodu HTML w środowisku może zostać wyświetlony błąd CORS podczas interakcji z elementem IFrame załadowanym przez widżet. Ten problem występuje, ponieważ element IFrame jest obsługiwany z innego źródła niż portal dla deweloperów. Aby uniknąć tego problemu, możesz zamiast tego użyć niestandardowego widżetu.

Jakie uprawnienia muszę edytować w portalu deweloperów?

Jeśli podczas otwierania Oops. Something went wrong. Please try again later. portalu w trybie administracyjnym występuje błąd, może brakować wymaganych uprawnień (RBAC platformy Azure).

Portal wymaga uprawnienia Microsoft.ApiManagement/service/users/token/action w zakresie /subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.ApiManagement/service/<apim-service-name>/users/1.

Aby utworzyć rolę z wymaganym uprawnieniem, możesz użyć następującego skryptu programu PowerShell. Pamiętaj, aby zmienić <subscription-id> parametr.

#New Portals Admin Role 
Import-Module Az 
Connect-AzAccount 
$contributorRole = Get-AzRoleDefinition "API Management Service Contributor" 
$customRole = $contributorRole 
$customRole.Id = $null
$customRole.Name = "APIM New Portal Admin" 
$customRole.Description = "This role gives the user ability to log in to the new Developer portal as administrator" 
$customRole.Actions = "Microsoft.ApiManagement/service/users/token/action" 
$customRole.IsCustom = $true 
$customRole.AssignableScopes.Clear() 
$customRole.AssignableScopes.Add('/subscriptions/<subscription-id>') 
New-AzRoleDefinition -Role $customRole

Po utworzeniu roli można ją udzielić dowolnemu użytkownikowi w sekcji Kontrola dostępu (IAM) w witrynie Azure Portal. Przypisanie tej roli użytkownikowi spowoduje przypisanie uprawnienia w zakresie usługi. Użytkownik będzie mógł wygenerować tokeny SAS w imieniu dowolnego użytkownika w usłudze. Ta rola musi być co najmniej przypisana do administratora usługi. Następujące polecenie programu PowerShell pokazuje, jak przypisać rolę użytkownikowi user1 w najniższym zakresie, aby uniknąć udzielania niepotrzebnych uprawnień użytkownikowi:

New-AzRoleAssignment -SignInName "user1@contoso.com" -RoleDefinitionName "APIM New Portal Admin" -Scope "/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.ApiManagement/service/<apim-service-name>/users/1"

Po udzieleniu użytkownikowi uprawnień użytkownik musi wylogować się i zalogować się ponownie w witrynie Azure Portal, aby nowe uprawnienia zaczęły obowiązywać.

Widzę `Unable to start the portal. See if settings are specified correctly (...)` błąd

Ten błąd jest wyświetlany, gdy wywołanie GET nie powiedzie się https://<management-endpoint-hostname>/subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.ApiManagement/service/xxx/contentTypes/document/contentItems/configuration?api-version=2018-06-01-preview . Wywołanie jest wydawane z przeglądarki przez interfejs administracyjny portalu.

Jeśli usługa API Management znajduje się w sieci wirtualnej, zapoznaj się z pytaniem dotyczącym łączności z siecią wirtualną.

Błąd wywołania może być również spowodowany certyfikatem TLS/SSL przypisanym do domeny niestandardowej i nie jest zaufany przez przeglądarkę. Jako środki zaradcze można usunąć domenę niestandardową punktu końcowego zarządzania. Usługa API Management wróci do domyślnego punktu końcowego z zaufanym certyfikatem.

Jaka jest obsługa przeglądarki dla portalu?

Przeglądarka	Obsługiwane
Apple Safari	Tak¹
Google Chrome	Tak¹
Microsoft Edge	Tak¹
Microsoft Internet Explorer	Nie.
Mozilla Firefox	Tak¹

¹ Obsługiwane w dwóch najnowszych wersjach produkcyjnych.

Lokalne tworzenie własnego portalu nie działa już

Jeśli lokalna wersja portalu dla deweloperów nie może zapisać ani pobrać informacji z konta magazynu lub wystąpienia usługi API Management, tokeny SAS mogły wygasły. Można to naprawić, generując nowe tokeny. Aby uzyskać instrukcje, zapoznaj się z samouczkiem dotyczącym samodzielnego hostowania portalu deweloperów.

Jeśli domyślnie nie potrzebujesz funkcji rejestracji włączonej w portalu dla deweloperów, możesz ją wyłączyć, wykonując następujące czynności:

W witrynie Azure Portal przejdź do wystąpienia usługi API Management.
W obszarze Portal deweloperów w menu wybierz pozycję Tożsamości.
Usuń każdego dostawcę tożsamości wyświetlanego na liście. Wybierz każdego dostawcę, wybierz menu kontekstowe (...), a następnie wybierz pozycję Usuń.
Przejdź do interfejsu administracyjnego portalu deweloperów.
Usuń linki rejestracji i elementy nawigacji w zawartości portalu. Aby uzyskać informacje na temat dostosowywania zawartości portalu, zobacz Samouczek: dostęp i dostosowywanie portalu deweloperów.
Zmodyfikuj zawartość strony rejestracji , aby usunąć pola używane do wprowadzania danych tożsamości, jeśli użytkownicy przechodzą bezpośrednio do niej.

Opcjonalnie usuń stronę Rejestracja . Obecnie używasz interfejsów API REST contentItem do wyświetlania listy i usuwania tej strony.
Zapisz zmiany i opublikuj ponownie portal.

Jak usunąć zawartość portalu dla deweloperów aprowizowaną w usłudze API Management?

Podaj wymagane parametry w scripts.v3/cleanup.bat skrycie w repozytorium GitHub portalu dla deweloperów i uruchom skrypt

cd scripts.v3
.\cleanup.bat
cd ..

Jak mogę włączyć uwierzytelnianie jednokrotne (SSO) w portalu dla deweloperów hostowanych samodzielnie?

Wśród innych metod uwierzytelniania portal deweloperów obsługuje logowanie jednokrotne . Aby uwierzytelnić się za pomocą tej metody, należy wykonać wywołanie elementu /signin-sso za pomocą tokenu w parametrze zapytania:

https://contoso.com/signin-sso?token=[user-specific token]

Generowanie tokenów użytkownika

Tokeny specyficzne dla użytkownika (w tym tokeny administracyjne) można wygenerować przy użyciu operacji Uzyskiwanie tokenu dostępu współdzielonego interfejsu API REST usługi API Management.

Uwaga

Token musi być zakodowany w adresie URL.

Dowiedz się więcej o portalu dla deweloperów:

Uzyskiwanie dostępu do portalu dla deweloperów zarządzanych i dostosowywanie go
Rozszerzanie funkcjonalności portalu dla deweloperów.
Konfigurowanie własnej wersji portalu

Przeglądaj inne zasoby:

Repozytorium GitHub z kodem źródłowym

Udostępnij za pośrednictwem

Portal deweloperów usługi API Management — często zadawane pytania

Co zrobić, jeśli potrzebuję funkcji, które nie są obsługiwane w portalu?

Czy mogę mieć wiele portali deweloperów w jednej usłudze API Management?

Czy portal obsługuje szablony usługi Azure Resource Manager i/lub czy jest zgodny z zestawem Resource Kit devOps usługi API Management?

Czy zawartość portalu jest zapisywana z funkcją tworzenia/przywracania kopii zapasowej w usłudze API Management?

Czy muszę włączyć dodatkową łączność z siecią wirtualną dla zależności portalu zarządzanego?

Przypisano niestandardową domenę usługi API Management, a opublikowany portal nie działa

Dodano dostawcę tożsamości i nie widzę go w portalu

Konfiguruję delegowanie, a portal nie używa go

Moje inne zmiany konfiguracji usługi API Management nie zostały rozpropagowane w portalu dla deweloperów

Otrzymuję błąd CORS podczas korzystania z konsoli interaktywnej

Otrzymuję błąd CORS podczas korzystania z niestandardowego widżetu kodu HTML

Jakie uprawnienia muszę edytować w portalu deweloperów?

Widzę `Unable to start the portal. See if settings are specified correctly (...)` błąd

Jaka jest obsługa przeglądarki dla portalu?

Lokalne tworzenie własnego portalu nie działa już

Jak usunąć zawartość portalu dla deweloperów aprowizowaną w usłudze API Management?

Jak mogę włączyć uwierzytelnianie jednokrotne (SSO) w portalu dla deweloperów hostowanych samodzielnie?

Generowanie tokenów użytkownika

Opinia

Dodatkowe zasoby

Udostępnij za pośrednictwem

Portal deweloperów usługi API Management — często zadawane pytania

Co zrobić, jeśli potrzebuję funkcji, które nie są obsługiwane w portalu?

Czy mogę mieć wiele portali deweloperów w jednej usłudze API Management?

Czy portal obsługuje szablony usługi Azure Resource Manager i/lub czy jest zgodny z zestawem Resource Kit devOps usługi API Management?

Czy zawartość portalu jest zapisywana z funkcją tworzenia/przywracania kopii zapasowej w usłudze API Management?

Czy muszę włączyć dodatkową łączność z siecią wirtualną dla zależności portalu zarządzanego?

Przypisano niestandardową domenę usługi API Management, a opublikowany portal nie działa

Dodano dostawcę tożsamości i nie widzę go w portalu

Konfiguruję delegowanie, a portal nie używa go

Moje inne zmiany konfiguracji usługi API Management nie zostały rozpropagowane w portalu dla deweloperów

Otrzymuję błąd CORS podczas korzystania z konsoli interaktywnej

Otrzymuję błąd CORS podczas korzystania z niestandardowego widżetu kodu HTML

Jakie uprawnienia muszę edytować w portalu deweloperów?

Widzę Unable to start the portal. See if settings are specified correctly (...) błąd

Jaka jest obsługa przeglądarki dla portalu?

Lokalne tworzenie własnego portalu nie działa już

Jak mogę wyłączyć rejestrację w portalu deweloperów?

Jak usunąć zawartość portalu dla deweloperów aprowizowaną w usłudze API Management?

Jak mogę włączyć uwierzytelnianie jednokrotne (SSO) w portalu dla deweloperów hostowanych samodzielnie?

Generowanie tokenów użytkownika

Powiązana zawartość

Opinia

Dodatkowe zasoby

Widzę `Unable to start the portal. See if settings are specified correctly (...)` błąd