Udostępnij przez

Migracja do nowego portalu deweloperów

W tym artykule opisano kroki, które należy wykonać, aby przeprowadzić migrację ze starszego portalu do nowego portalu deweloperów w usłudze 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 usługi API Management

DOTYCZY: Developer | Podstawowa | Standardowa | Premia

Ulepszenia w nowym portalu dla deweloperów

Nowy portal deweloperów dotyczy wielu ograniczeń przestarzałego portalu. Zawiera wizualny edytor przeciągania i upuszczania do edytowania zawartości oraz dedykowany panel dla projektantów do stylizowania 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. Na koniec baza kodu portalu jest bazą danych typu open source, dzięki czemu można ją rozszerzyć za pomocą funkcji niestandardowych.

Jak przeprowadzić migrację do nowego portalu dla deweloperów

Nowy portal dla 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 będą się różnić 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 portal deweloperów został uruchomiony wcześniej, 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 dla deweloperów z listy rozwijanej w witrynie Azure Portal.

  • Zastosuj politykę CORS w interfejsach API, aby włączyć konsolę testów interaktywnych.

  • 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 samodzielnie hostowanej wersji nowego portalu.

  • Jeśli usługa API Management znajduje się w sieci wirtualnej i jest uwidoczniona w Internecie za pośrednictwem usługi Application Gateway, zapoznaj się z tym artykułem dokumentacji, aby uzyskać szczegółowe instrukcje konfiguracji. Musisz:

    • Włącz łączność z punktem końcowym zarządzania usługi API Management.
    • Włącz łączność z nowym punktem końcowym portalu.
    • Wyłącz wybrane reguły zapory aplikacji internetowej.

  • Jeśli zmieniono domyślne szablony powiadomień e-mail, aby zawierały jawnie zdefiniowany przestarzały adres URL portalu, dostosuj je, aby używały parametru adresu URL portalu lub wskazywały na 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 deweloperów.

  • Bezpośrednia integracja z serwisami Facebook, Microsoft, Twitter i Google jako dostawcami tożsamości nie jest obsługiwana w nowym portalu deweloperów. Integrację z tymi dostawcami można zintegrować za pośrednictwem usługi Azure AD B2C.

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

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

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

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

    • Zmień zwracany adres URL w aplikacji, aby wskazywał nową domenę portalu deweloperów.
    • Zmodyfikuj sufiks zwracanego adresu URL w aplikacji z /signin-aad do /signin.
    • Uwzględnij podane 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 programu 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.

Dalsze kroki

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

  • Last updated on