Migrowanie portalu interfejsu API za pomocą planu Azure Spring Apps Enterprise do usługi Azure API Management

Ten artykuł dotyczy: ❎ Podstawowa/Standardowa ✅ Enterprise

W tym artykule opisano sposób migrowania portalu interfejsu API do usługi Azure API Management.

Usługa Azure API Management udostępnia scentralizowany interfejs do wyświetlania definicji interfejsu API i testowania określonych tras interfejsu API bezpośrednio z przeglądarki. Obsługuje również logowanie jednokrotne (SSO) w celu zwiększenia bezpieczeństwa i bezproblemowego dostępu. Migrowanie z witryny API Portal z usługą Azure Spring Apps do usługi Azure API Management zwiększa skalowalność, bezpieczeństwo i integrację z innymi usługami platformy Azure.

Prerequisites

• Istniejące wystąpienie planu Azure Spring Apps Enterprise z włączonym Portalem API.
• Istniejąca aplikacja kontenera platformy Azure. Aby uzyskać więcej informacji, zobacz temat Szybki start: Wdrażanie pierwszej aplikacji kontenera przy użyciu witryny Azure Portal.

Utwórz wystąpienie zarządzania API

Aby utworzyć wystąpienie usługi API Management, wykonaj następujące czynności:

1. W witrynie Azure Portal wyszukaj usługę API Management na pasku wyszukiwania.

2. Wybierz pozycję Usługi API Management z wyników, a następnie wybierz pozycję Utwórz.

3. Podaj następujące wymagane informacje:

   • Subskrypcja: wybierz subskrypcję platformy Azure dla swojej usługi.
   • Grupa zasobów: wybierz istniejącą grupę zasobów lub wybierz pozycję Utwórz nową , aby utworzyć nową.
   • Region: wybierz lokalizację lub region wystąpienia usługi API Management.
   • Nazwa zasobu: podaj globalnie unikatową nazwę wystąpienia usługi API Management.
   • Nazwa organizacji: określ nazwę organizacji.
   • Adres e-mail administratora: Podaj adres e-mail używany do powiadomień związanych z instancją zarządzania interfejsem API.

4. Wybierz warstwę cenową na podstawie przypadku użycia. Zawsze możesz uaktualnić lub zmienić warstwę cenową później.

5. Skonfiguruj opcjonalne ustawienia, takie jak monitorowanie i ustawienia sieci wirtualnej.

6. Wybierz pozycję Przejrzyj i utwórz , aby przejrzeć ustawienia i zweryfikować konfigurację.

7. Po zakończeniu walidacji wybierz pozycję Utwórz. Wdrożenie może potrwać od 30 do 40 minut.

8. Po zakończeniu wdrażania przejdź do strony usługi API Management , aby wyświetlić nowo utworzoną usługę.

Importowanie uwidocznionych interfejsów API w usłudze API Management

Istnieją dwie opcje importowania interfejsów API w usłudze API Management: ręczne dodawanie interfejsów API lub importowanie pliku specyfikacji interfejsu API.

Ręczne dodawanie interfejsów API

Aby ręcznie dodać interfejsy API, wykonaj następujące czynności:

1. Przejdź do wystąpienia API Management w portalu Azure. W sekcji Interfejsy API wybierz pozycję Dodaj interfejs API.

2. W okienku Definiowanie nowego interfejsu API wybierz opcję HTTP , aby ręcznie zdefiniować interfejs API HTTP.

3. Podaj następujące wartości Podstawy interfejsu API , a następnie wybierz pozycję Utwórz , aby zapisać:

   • Nazwa wyświetlana: podaj nazwę interfejsu API.
   • Nazwa: wprowadź unikatowy identyfikator interfejsu API.
   • Adres URL usługi internetowej: Podaj podstawowy adres URL interfejsu API zaplecza dla aplikacji kontenerowych.
   • Sufiks adresu URL interfejsu API: zdefiniuj sufiks dla tego interfejsu API — na przykład /api/customers-service.

4. Aby utworzyć nowe punkty końcowe interfejsu API, wybierz pozycję Dodaj operację, a następnie wykonaj następujące kroki:

   1. Podaj ogólne informacje. Nazwa wyświetlana i Nazwa.
   2. Podaj szczegóły operacji, takie jak czasownik - GET HTTP, POSTitd. — adres URL, parametry zapytania, żądanie i odpowiedź.
   3. Po dodaniu wszystkich operacji zapisz interfejs API.

5. Wybierz nazwy dodanych interfejsów API. Wszystkie operacje dodane na karcie Projektowanie są widoczne.

Importowanie pliku specyfikacji interfejsu API

Jeśli masz specyfikację interfejsu OpenAPI — definicję struktury Swagger — interfejsów API, możesz bezpośrednio zaimportować do usługi API Management, wykonując następujące kroki:

1. Przejdź do wystąpienia API Management w portalu Azure.

2. Otwórz sekcję Interfejsy API w obszarze Interfejsy API.

3. Wybierz pozycję Dodaj interfejs API.

4. W obszarze Utwórz na podstawie definicji wybierz opcję OpenAPI , która tworzy standardowy, niezależny od języka interfejs API REST.

5. Wykonaj następujące kroki, aby utworzyć interfejs API na podstawie specyfikacji interfejsu OpenAPI:

   1. Jeśli masz lokalny plik specyfikacji interfejsu API, wybierz pozycję Wybierz plik , aby przekazać plik. Alternatywnie podaj publicznie dostępny adres URL specyfikacji interfejsu OpenAPI.
   2. Ustawienia interfejsu API można dodatkowo uściślić, podając wartości sufiksu Nazwa wyświetlana, Nazwa i Adres URL interfejsu API dla interfejsów API.
   3. Aby zapisać konfiguracje, wybierz pozycję Utwórz.

6. Wybierz nazwę dodanych interfejsów API. Wszystkie operacje dodane na karcie Projektowanie są widoczne.

Wypróbuj interfejsy API w usłudze API Management

Usługa Azure API Management udostępnia wbudowaną konsolę testową w witrynie Azure Portal, co ułatwia interakcję z interfejsami API bez konieczności używania narzędzi zewnętrznych. Aby przetestować interfejsy API, wykonaj następujące czynności:

1. Przejdź do wystąpienia API Management w portalu Azure.

2. W sekcji Interfejsy API wybierz interfejs API, który chcesz przetestować z listy.

3. Wybierz operację. Na stronie przeglądu interfejsu API można wyświetlić listę dostępnych operacji (punktów końcowych). Wybierz operację, którą chcesz przetestować.

4. Wybierz kartę Test , aby otworzyć ją w witrynie Azure Portal.

5. Konfigurowanie parametrów żądania. Wprowadź niezbędne parametry dla żądania, takie jak parametry ścieżki, parametry zapytania, nagłówki lub treść, w zależności od metody interfejsu API. Jeśli interfejs API wymaga elementu Authorization Token, pamiętaj, aby uwzględnić go w nagłówku.

6. Wyślij żądanie. Po podaniu szczegółów żądania wybierz pozycję Wyślij. Odpowiedź z interfejsu API jest wyświetlana bezpośrednio w witrynie Azure Portal, w tym w kodzie odpowiedzi, treści odpowiedzi i nagłówkach.

7. Sprawdź odpowiedź. Przejrzyj dane odpowiedzi, kody stanu i wszelkie komunikaty o błędach, które mogą wskazywać na problemy z interfejsem API lub żądaniem.

Migrowanie logowania jednokrotnego do usługi API Management

Jeśli włączysz logowanie jednokrotne w witrynie API Portal i chcesz uwierzytelnić żądania w usłudze API Management, wykonaj następujące kroki, aby skonfigurować tożsamość w usłudze API Management:

1. Na portalu Azure przejdź do instancji usługi API Management.

2. Przejdź do portalu deweloperów>tożsamości.

3. Wybierz pozycję Dodaj , a następnie wybierz pozycję Azure Active Directory.

4. Wypełnij wymagane pola:

   • Identyfikator klienta: identyfikator aplikacji lub klienta zarejestrowanej aplikacji Microsoft Entra ID.
   • Klucz tajny klienta: Tajemnica aplikacji Microsoft Entra ID.
   • Dzierżawca logowania: nazwa domeny dzierżawy Microsoft Entra ID, na przykład yourcompany.onmicrosoft.com
   • Adres URL przekierowania: zazwyczaj https://{your-apim-instance}.developer.azure-api.net/signin.

5. Wybierz Dodaj, aby zapisać dostawcę tożsamości.

Przed zapisaniem nowego dodanego dostawcy tożsamości należy dodać adres URL przekierowania do listy dozwolonych adresów URL przekierowania aplikacji klienckiej Microsoft Entra ID.

Aby uzyskać więcej konfiguracji usługi API Management, zobacz dokumentację usługi API Management.