Udostępnij za pośrednictwem

Migrowanie do nowego portalu deweloperów

  • Artykuł

W tym artykule opisano kroki, które należy wykonać, aby przeprowadzić migrację ze starszego portalu przestarzałego do nowego portalu deweloperów w API Management.

Ważne

Starszy portal deweloperów jest teraz uznawany za przestarzały i będzie aktualizowany tylko o poprawki zabezpieczeń. Można z niego korzystać na dotychczasowych zasadach aż do jego wycofania w październiku 2023 r., kiedy zostanie usunięty ze wszystkich usług API Management.

Portal deweloperów API Management

Dostępność

Ważne

Ta funkcja jest dostępna w warstwach Premium, Standardowa, Podstawowa i Deweloper usługi API Management.

Aby uzyskać informacje o dostępności funkcji w warstwach 2 (wersja zapoznawcza), zobacz Omówienie warstw w wersji 2.

Ulepszenia w nowym portalu dla deweloperów

Nowy portal dla deweloperów dotyczy wielu ograniczeń przestarzałego portalu. Zawiera ona wizualny edytor przeciągania i upuszczania do edytowania zawartości oraz dedykowany panel dla projektantów w celu stylu witryny internetowej. Strony, dostosowania i konfiguracja są zapisywane jako zasoby usługi Azure Resource Manager w usłudze API Management, co pozwala zautomatyzować wdrożenia portalu. Ponadto baza kodu portalu jest bazą danych typu open source, dzięki czemu można ją rozszerzyć o funkcje niestandardowe.

Jak przeprowadzić migrację do nowego portalu deweloperów

Nowy portal deweloperów jest niezgodny z przestarzałym portalem, a automatyczna migracja nie jest możliwa. Musisz ręcznie ponownie utworzyć zawartość (strony, tekst, pliki multimedialne) i dostosować wygląd nowego portalu. Dokładne kroki różnią się w zależności od dostosowań i złożoności portalu. Aby uzyskać wskazówki, zapoznaj się z samouczkiem dotyczącym portalu dla deweloperów . Pozostała konfiguracja, podobnie jak lista interfejsów API, produktów, użytkowników, dostawców tożsamości, jest automatycznie udostępniana w obu portalach.

Ważne

Jeśli wcześniej uruchomiono nowy portal dla deweloperów, ale nie wprowadzono żadnych zmian, zresetuj domyślną zawartość, aby zaktualizować ją do najnowszej wersji.

Podczas migracji z przestarzałego portalu należy pamiętać o następujących zmianach:

  • Jeśli uwidaczniasz portal dla deweloperów za pośrednictwem domeny niestandardowej, przypisz domenę do nowego portalu deweloperów. Użyj opcji Portal deweloperów z listy rozwijanej w Azure Portal.

  • Zastosuj zasady CORS do interfejsów API, aby włączyć interaktywną konsolę testowania.

  • Jeśli wstrzykujesz niestandardowy kod CSS do stylu portalu, musisz zreplikować styl przy użyciu wbudowanego panelu projektowego. Iniekcja CSS nie jest dozwolona w nowym portalu.

  • Niestandardowy kod JavaScript można wstrzyknąć tylko w własnej wersji nowego portalu.

  • Jeśli twoja API Management znajduje się w sieci wirtualnej i jest widoczna w Internecie za pośrednictwem Application Gateway, zapoznaj się z tym artykułem dokumentacji, aby uzyskać dokładne kroki konfiguracji. Musisz:

    • Włącz łączność z punktem końcowym zarządzania API Management.
    • Włącz łączność z nowym punktem końcowym portalu.
    • Wyłącz wybrane reguły Web Application Firewall.

  • Jeśli domyślne szablony powiadomień e-mail zostały zmienione tak, aby zawierały jawnie zdefiniowany przestarzały adres URL portalu, zmień je na użyj parametru adresu URL portalu lub wskaż nowy adres URL portalu. Jeśli szablony używają wbudowanego parametru adresu URL portalu, nie są wymagane żadne zmiany.

  • Problemy i aplikacje nie są obsługiwane w nowym portalu dla deweloperów.

  • Bezpośrednia integracja z serwisami Facebook, Microsoft, Twitter i Google, ponieważ dostawcy tożsamości nie są obsługiwani w nowym portalu dla deweloperów. Integrację z tymi dostawcami można zintegrować za pośrednictwem Azure AD B2C.

  • Jeśli używasz delegowania, zmień zwracany adres URL w aplikacjach i użyj punktu końcowego uzyskiwania tokenu dostępu współdzielonego zamiast punktu końcowego Generowanie adresu URL logowania jednokrotnego.

  • Jeśli używasz identyfikatora Microsoft Entra jako dostawcy tożsamości:

    • Zmień adres URL powrotu w aplikacji, aby wskazywał nową domenę portalu dla deweloperów.
    • Zmodyfikuj sufiks zwracanego adresu URL w aplikacji z /signin-aad na /signin.

  • Jeśli używasz Azure AD B2C jako dostawcy tożsamości:

    • Zmień adres URL powrotu w aplikacji, aby wskazywał nową domenę portalu dla deweloperów.
    • Zmodyfikuj sufiks zwracanego adresu URL w aplikacji z /signin-aad na /signin.
    • Uwzględnij imię, nazwisko i identyfikator obiektu użytkownika w oświadczeniach aplikacji.

  • Jeśli używasz protokołu OAuth 2.0 w konsoli testów interakcyjnych, zmień adres URL powrotu w aplikacji, aby wskazywał nową domenę portalu deweloperów i zmodyfikuj sufiks:

    • Od /docs/services/[serverName]/console/oauth2/authorizationcode/callback do /signin-oauth/code/callback/[serverName] dla przepływu udzielania kodu autoryzacji.
    • Od /docs/services/[serverName]/console/oauth2/implicit/callback do /signin-oauth/implicit/callback dla niejawnego przepływu udzielania.

  • Jeśli używasz narzędzia OpenID Connect w konsoli testów interakcyjnych, zmień adres URL powrotu w aplikacji, aby wskazywał nową domenę portalu dla deweloperów i zmodyfikuj sufiks:

    • Od /docs/services/[serverName]/console/openidconnect/authorizationcode/callback do /signin-oauth/code/callback/[serverName] dla przepływu udzielania kodu autoryzacji.
    • Od /docs/services/[serverName]/console/openidconnect/implicit/callback do /signin-oauth/implicit/callback dla niejawnego przepływu udzielania.

Następne kroki

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