API Management i doskonałość operacyjna
Dowiedz się, jak bezpiecznie i na dużą skalę używać API Management do publikowania interfejsów API zewnętrznych, partnerów i deweloperów pracowników. Ta usługa sieciowa to hybrydowa, wielochmurowa platforma zarządzania dla interfejsów API we wszystkich środowiskach.
Składniki obejmują:
Aby uzyskać więcej informacji, zobacz Informacje o API Management.
Aby dowiedzieć się, jak API Management obsługuje doskonałość operacyjną, zapoznaj się z następującymi tematami:
- Zarządzanie usługą Azure API Management przy użyciu usługi Azure Automation
- Możliwość obserwowania w usłudze Azure API Management
Lista kontrolna
Czy skonfigurowano API Management z myślą o doskonałości operacyjnej?
- Zabezpieczanie komunikacji między API Management a zapleczem.
- Upewnij się, że każda strona ma własne poświadczenia podczas ujawniania interfejsów API osobom trzecim.
- Upewnij się, że ustawiono limity przydziału i limity szybkości podczas ujawniania interfejsów API osobom trzecim.
- Zapoznaj się ze wskazówkami dotyczącymi projektowania i architektury interfejsu API REST firmy Microsoft.
- Włącz przechowywanie wersji interfejsów API, aby zachować zgodność z poprzednimi wersjami podczas dodawania innych funkcji.
- Aby zaimplementować przechowywanie wersji interfejsu API, użyj funkcji API Management Versioning and Revisions.
- Zapoznaj się z ograniczeniami importowania interfejsu API w API Management.
- Omówienie funkcji rejestrowania zdarzeń.
- Śledzenie wywołań w usłudze Azure API Management w celu ułatwienia debugowania i testowania.
- Konfigurowanie rejestrowania przy użyciu usługi Azure Monitor dla usługi API Management.
- Wybierz odpowiednie tryby uzyskiwania dostępu do połączeń lokacji prywatnej.
- Oceń reguły zapory i listy dozwolonych adresów IP na podstawie API Management publicznego adresu IP.
Zalecenia dotyczące konfiguracji
Podczas konfigurowania usługi API Management należy wziąć pod uwagę następujące zalecenia dotyczące doskonałości operacyjnej:
Zalecenie | Opis |
---|---|
Upewnij się, że ustawiono limity przydziału i limity szybkości podczas ujawniania interfejsów API osobom trzecim. | Ochrona usług zaplecza i zmniejszenie obciążenia umieszczonego na jednostce skalowania API Management. Zasady ograniczania szybkości można zastosować na poziomach globalnych, produktu, interfejsu API i operacji w celu zapewnienia dostosowania limitu szybkości stosowanego do użytkowników interfejsu API. |
Zapoznaj się ze wskazówkami dotyczącymi projektowania i architektury interfejsu API REST firmy Microsoft. | Postępuj zgodnie ze standardami i najlepszymi rozwiązaniami podczas korzystania z interfejsu API REST. Poniższe najlepsze rozwiązania umożliwiają maksymalną zgodność między platformami i implementacjami. Zapoznaj się ze wskazówkami dotyczącymi interfejsu API REST i wskazówki dotyczące projektowania interfejsu API. |
Zapoznaj się z ograniczeniami importowania interfejsu API w API Management. | Każdy wysiłek polega na bezproblemowym uruchomieniu procesu importowania interfejsu API, który obejmuje brak dostosowań. Niektóre scenariusze nakładają ograniczenia, które będą wymagać modyfikacji źródła importu. Dotyczy usług REST i SOAP. Ograniczenia zasad referencyjnych dla bieżących ograniczeń importu interfejsu API. |
Omówienie funkcji rejestrowania zdarzeń. | Obsługuje rejestrowanie zdarzeń w centrum zdarzeń platformy Azure w celu przeprowadzania analizy niemal w czasie rzeczywistym. Ta funkcja integruje się z zewnętrznymi rozwiązaniami do rejestrowania, informacji zabezpieczających i zarządzania zdarzeniami (SIEM) lub analizowania użycia interfejsu API w czasie niemal rzeczywistym. |
Śledzenie wywołań w usłudze Azure API Management w celu ułatwienia debugowania i testowania. | Śledzenie musi być włączone w subskrypcji używanej do wykonania żądania. Śledzenie jest włączone w oparciu o żądanie przy użyciu wartości nagłówka Ocp-Apim-Trace . Śledzenie interfejsu API jest również wbudowane w portal administracyjny i jest domyślnie włączone podczas testowania interfejsów API z portalu. |
Konfigurowanie rejestrowania przy użyciu usługi Azure Monitor dla usługi API Management. | Dzienniki można wysyłać do obszaru roboczego usługi Logs Analytics, aby umożliwić złożone wykonywanie zapytań i analizę. Metryki można pozyskiwać na potrzeby dłuższej analizy. Wszystkie dane są następnie udostępniane przy użyciu usługi Azure Monitor. Istnieje możliwość zintegrowania usługi Application Insights z usługą Application Performance Management. |
Wybierz odpowiednie tryby uzyskiwania dostępu do połączeń lokacji prywatnej. | Obsługuje integrację Virtual Network w trybie wewnętrznym i zewnętrznym. |
Oceń reguły zapory i listy dozwolonych adresów IP na podstawie API Management publicznego adresu IP. | Stały publiczny adres IP jest dostępny dla okresu istnienia usługi z planami Podstawowa, Deweloper, Standardowa i Premium dla API Management. |