Udostępnij za pośrednictwem

Automatyzowanie wdrożeń portalu dla deweloperów

  • Artykuł

DOTYCZY: Developer | Podstawowa | Standardowa | Premia

Portal deweloperów usługi API Management obsługuje dostęp programowy do zawartości. Umożliwia importowanie lub eksportowanie danych z usługi API Management za pomocą interfejsu API REST zarządzania zawartością. Dostęp do interfejsu API REST działa zarówno dla portali zarządzanych, jak i własnych.

Skrypt automatycznej migracji

Za pomocą interfejsu API można zautomatyzować migrację zawartości między dwiema usługami API Management — na przykład usługą w środowisku testowym i usługą w środowisku produkcyjnym. Skrypt scripts.v3/migrate.js w repozytorium GitHub portalu deweloperów usługi API Management upraszcza ten proces automatyzacji.

Ostrzeżenie

Skrypt usuwa zawartość portalu deweloperów w docelowej usłudze API Management. Jeśli się o to martwisz, upewnij się, że wykonasz kopię zapasową.

Uwaga

Migrowanie zawartości portalu dla deweloperów między wystąpieniem usługi API Management w warstwie klasycznej (na przykład Standard) i wystąpieniem w warstwie 2 (na przykład w wersji 2) nie jest obecnie obsługiwane. Migracja zawartości portalu między wystąpieniami w warstwach v2 również nie jest obsługiwana.

Uwaga

Jeśli używasz portalu self-hosted z jawnie zdefiniowanym niestandardowym kontem magazynu do hostowania plików multimedialnych (tj. definiujesz ustawienie w config.design.json pliku konfiguracji), musisz użyć oryginalnego scripts/migrate.jsskryptu.blobStorageUrl Oryginalny skrypt nie działa w przypadku portali zarządzanych ani samodzielnie hostowanych przy użyciu konta magazynu multimediów zarządzanego przez usługę API Management. W takim przypadku użyj skryptu /scripts.v3 z folderu .

Skrypt wykonuje następujące kroki:

  1. Przechwyć zawartość portalu i nośnik z źródłowej usługi API Management.
  2. Usuń zawartość i multimedia portalu z docelowej usługi API Management.
  3. Przekaż zawartość i multimedia portalu do docelowej usługi API Management.
  4. Opcjonalnie i tylko w przypadku portali zarządzanych — automatycznie opublikuj portal.

Po pomyślnym wykonaniu skryptu docelowa usługa API Management powinna zawierać tę samą zawartość portalu co usługa źródłowa i będzie można ją zobaczyć jako administrator.

  • Jeśli używasz portalu zarządzanego, możesz ustawić skrypt tak, aby automatycznie opublikować portal docelowy, aby migrowana wersja została automatycznie udostępniona odwiedzającym.
  • Jeśli używasz portalu hostowanego samodzielnie, musisz ręcznie opublikować portal docelowy. Postępuj zgodnie z instrukcjami dotyczącymi publikowania i hostowania w samouczku, aby skonfigurować portal dla deweloperów hostowanych samodzielnie.

Następne kroki

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