Co to jest usługa Azure API Management?

DOTYCZY: Wszystkie warstwy usługi API Management

Ten artykuł zawiera omówienie typowych scenariuszy i kluczowych składników usługi Azure API Management. Usługa Azure API Management to hybrydowa, wielochmurowa platforma do zarządzania interfejsami API we wszystkich środowiskach. Jako platforma jako usługa usługa API Management obsługuje pełny cykl życia interfejsu API.

Napiwek

Jeśli znasz już usługę API Management i wszystko jest gotowe do uruchomienia, zobacz następujące zasoby:

Scenariusze

Interfejsy API umożliwiają korzystanie ze środowisk cyfrowych, upraszczanie integracji aplikacji, wspieranie nowych produktów cyfrowych oraz ponowne korzystanie z danych i usług oraz ich powszechnie dostępne. Dzięki rozprzestrzenianiu się i zwiększaniu zależności od interfejsów API organizacje muszą zarządzać nimi jako zasoby pierwszej klasy w całym cyklu życia.

Diagram przedstawiający rolę interfejsów API w połączonych środowiskach.

Usługa Azure API Management pomaga klientom sprostać następującym wyzwaniom:

  • Abstrakcja różnorodności i złożoności architektury zaplecza od użytkowników interfejsu API
  • Bezpieczne uwidacznianie usług hostowanych na platformie Azure i poza platformą Azure jako interfejsów API
  • Ochrona, przyspieszanie i obserwowanie interfejsów API
  • Włączanie odnajdywania i użycia interfejsu API przez użytkowników wewnętrznych i zewnętrznych

Typowe scenariusze obejmują:

  • Odblokowywanie starszych zasobów — interfejsy API są używane do abstrakcji i modernizacji starszych zapleczy oraz udostępniania ich z nowych usług w chmurze i nowoczesnych aplikacji. Interfejsy API umożliwiają innowacje bez ryzyka, kosztów i opóźnień migracji.
  • Integracja aplikacji skoncentrowanych na interfejsie API — interfejsy API są łatwo eksploatacyjne, oparte na standardach i samoopisujące mechanizmy uwidaczniania i uzyskiwania dostępu do danych, aplikacji i procesów. Upraszczają i zmniejszają koszty integracji aplikacji.
  • Środowiska użytkownika obejmujące wiele kanałów — interfejsy API są często używane do włączania środowisk użytkownika, takich jak aplikacje internetowe, mobilne, do noszenia lub Internetu rzeczy. Ponowne używanie interfejsów API w celu przyspieszenia programowania i zwrotu z inwestycji.
  • Integracja B2B — interfejsy API udostępniane partnerom i klientom obniżają barierę integrowania procesów biznesowych i wymiany danych między jednostkami biznesowymi. Interfejsy API eliminują obciążenie związane z integracją punkt-punkt. Szczególnie w przypadku samoobsługowego odnajdywania i włączania dołączania interfejsy API są podstawowymi narzędziami do skalowania integracji B2B.

Składniki usługi API Management

Usługa Azure API Management składa się z bramy interfejsu API, płaszczyzny zarządzania i portalu dla deweloperów. Te składniki są domyślnie hostowane na platformie Azure i w pełni zarządzane. Usługa API Management jest dostępna w różnych warstwach różniących się pojemnością i funkcjami.

Diagram przedstawiający kluczowe składniki usługi Azure API Management.

Brama interfejsu API

Wszystkie żądania z aplikacji klienckich najpierw docierają do bramy interfejsu API, która następnie przekazuje je do odpowiednich usług zaplecza. Brama interfejsu API działa jako fasada usług zaplecza, umożliwiając dostawcom interfejsów API abstrakcję implementacji interfejsu API i rozwijanie architektury zaplecza bez wpływu na użytkowników interfejsu API. Brama umożliwia spójną konfigurację routingu, zabezpieczeń, ograniczania przepustowości, buforowania i obserwacji.

W szczególności brama:

Własna brama

Dzięki własnej bramie klienci mogą wdrażać bramę interfejsu API w tych samych środowiskach, w których hostują swoje interfejsy API, aby zoptymalizować ruch interfejsu API i zapewnić zgodność z lokalnymi przepisami i wytycznymi. Brama hostowana samodzielnie umożliwia klientom korzystanie z hybrydowej infrastruktury IT do zarządzania interfejsami API hostowanymi lokalnie i w różnych chmurach z jednej usługi API Management na platformie Azure.

Brama hostowana samodzielnie jest spakowana jako kontener platformy Docker oparty na systemie Linux i jest często wdrażana na platformie Kubernetes, w tym w usługach Azure Kubernetes Service i Kubernetes z obsługą usługi Azure Arc.

Więcej informacji:

Płaszczyzna zarządzania

Dostawcy interfejsu API wchodzą w interakcję z usługą za pośrednictwem płaszczyzny zarządzania, która zapewnia pełny dostęp do możliwości usługi API Management.

Klienci korzystają z płaszczyzny zarządzania za pośrednictwem narzędzi platformy Azure, w tym witryny Azure Portal, programu Azure PowerShell, interfejsu wiersza polecenia platformy Azure, rozszerzenia programu Visual Studio Code, interfejsu API REST lub zestawów SDK klienta w kilku popularnych językach programowania.

Użyj płaszczyzny zarządzania, aby:

  • Aprowizuj i konfiguruj ustawienia usługi API Management
  • Definiowanie lub importowanie schematów interfejsu API z szerokiej gamy źródeł, w tym definicji openAPI, WSDL i OData, usług obliczeniowych platformy Azure i protokołu WebSocket, graphQL i zapleczy gRPC
  • Interfejsy API pakietów do produktów
  • Konfigurowanie zasad , takich jak limity przydziału lub przekształcenia w interfejsach API
  • Uzyskiwanie szczegółowych informacji z analizy
  • Zarządzaj użytkownikami

Portal deweloperów

Portal dla deweloperów typu open source to automatycznie generowana, w pełni dostosowywalna witryna internetowa z dokumentacją interfejsów API.

Zrzut ekranu przedstawiający portal deweloperów usługi API Management — tryb administratora.

Dostawcy interfejsu API mogą dostosować wygląd i działanie portalu dla deweloperów, dodając zawartość niestandardową, dostosowując style i dodając znakowanie. Rozszerz portal dla deweloperów, korzystając z własnego hostingu.

Deweloperzy aplikacji używają portalu dla deweloperów typu open source do odnajdywania interfejsów API, dołączania ich do używania i dowiedz się, jak korzystać z nich w aplikacjach. (Interfejsy API można również wyeksportować do Platforma Power Platform do odnajdywania i używania przez deweloperów obywateli).

Za pomocą portalu dla deweloperów deweloperzy mogą wykonywać następujące czynności:

  • Przeczytaj dokumentację interfejsu API
  • Wywoływanie interfejsu API za pośrednictwem konsoli interaktywnej
  • Tworzenie konta i subskrybowanie w celu uzyskania kluczy interfejsu API
  • Uzyskiwanie dostępu do analizy własnego użycia
  • Pobieranie definicji interfejsu API
  • Zarządzaj kluczami interfejsu API

Warstwy usługi API Management

Usługa API Management jest oferowana w różnych warstwach cenowych, aby zaspokoić potrzeby różnych klientów. Każda warstwa oferuje różne kombinacje funkcji, wydajności, limitów pojemności, skalowalności, umowy SLA i cen dla różnych scenariuszy. Warstwy są pogrupowane w następujący sposób:

  • Klasyczny — oryginalna oferta usługi API Management, w tym warstwa Developer, Basic, Standard i Premium. Warstwa Premium jest przeznaczona dla przedsiębiorstw wymagających dostępu do prywatnych zapleczy, rozszerzonych funkcji zabezpieczeń, wdrożeń w wielu regionach, stref dostępności i wysokiej skalowalności. Warstwa Deweloper jest ekonomiczną opcją użycia nieprodukcyjnego, natomiast warstwy Podstawowa, Standardowa i Premium są warstwami gotowymi do produkcji.
  • Wersja 2 — nowy zestaw warstw, które oferują szybką aprowizację i skalowanie, w tym Podstawowa wersja 2 na potrzeby programowania i testowania oraz Standardowa v2 dla obciążeń produkcyjnych. Wersja Standardowa w wersji 2 obsługuje uproszczone połączenie z izolowanymi sieciami zaplecza.
  • Zużycie — warstwa Zużycie to bezserwerowa brama do zarządzania interfejsami API, które są skalowane na podstawie zapotrzebowania i rozliczane według wykonania. Jest przeznaczony dla aplikacji z bezserwerowymi architekturami obliczeniowymi, mikrousługami i zmiennymi wzorcami ruchu.

Więcej informacji:

Integracja z usługami Azure

Usługa API Management integruje się z wieloma uzupełniającymi usługami platformy Azure w celu tworzenia rozwiązań dla przedsiębiorstw, w tym:

Więcej informacji:

Najważniejsze pojęcia

Interfejsy API

Interfejsy API są podstawą wystąpienia usługi API Management. Każdy interfejs API reprezentuje zestaw operacji dostępnych dla deweloperów aplikacji. Każdy interfejs API zawiera odwołanie do usługi zaplecza, która implementuje interfejs API, oraz jego operacje mapowania na operacje zaplecza.

Operacje usługi API Management są wysoce konfigurowalne, pozwalają na kontrolę mapowania adresu URL, parametrów zapytania i ścieżki, zawartości żądania i odpowiedzi oraz buforowanie odpowiedzi operacji.

Więcej informacji:

Produkty

Produkty stanowią sposób udostępniania interfejsów API deweloperom. Produkty w usłudze API Management mają co najmniej jeden interfejs API i mogą być otwarte lub chronione. Chronione produkty wymagają klucza subskrypcji, a otwarte produkty mogą być używane bezpłatnie.

Kiedy produkt jest gotowy do użycia przez deweloperów, można go opublikować. Po opublikowaniu można go wyświetlić lub zasubskrybować za pomocą portalu deweloperów. Zatwierdzanie subskrypcji jest konfigurowane na poziomie produktu i może wymagać zatwierdzenia przez administratora lub być automatyczne.

Więcej informacji:

Grupy

Grupy służą do zarządzania widocznością produktów dla deweloperów. Usługa API Management ma następujące wbudowane grupy:

  • Administracja istratory — zarządzanie wystąpieniami usługi API Management i tworzenie interfejsów API, operacji i produktów używanych przez deweloperów.

    Administratorzy subskrypcji platformy Azure są członkami tej grupy.

  • Deweloperzy — uwierzytelnieni użytkownicy portalu deweloperów, którzy tworzą aplikacje przy użyciu interfejsów API. Deweloperzy otrzymują dostęp do portalu dla deweloperów i tworzą aplikacje, które wywołują operacje interfejsów API.

  • Goście — użytkownicy portalu deweloperów nieuwierzytelniony, tacy jak potencjalni klienci odwiedzający portal deweloperów. Mogą mieć przyznany pewien zakres dostępu tylko do odczytu, czyli np. możliwość wyświetlania interfejsów API, ale nie ich wywoływania.

Administracja istratory mogą również tworzyć grupy niestandardowe lub używać grup zewnętrznych w skojarzonej dzierżawie firmy Microsoft Entra, aby zapewnić deweloperom widoczność i dostęp do produktów interfejsu API. Na przykład utwórz grupę niestandardową dla deweloperów w organizacji partnerskiej, aby uzyskać dostęp do określonego podzestawu interfejsów API w produkcie. Użytkownik może należeć do więcej niż jednej grupy.

Więcej informacji:

Deweloperzy

Deweloperzy reprezentują konta użytkowników w wystąpieniu usługi API Management. Deweloperzy mogą zostać utworzeni lub zaproszeni do dołączenia przez administratorów albo zarejestrować się w portalu deweloperów. Każdy deweloper jest członkiem co najmniej jednej grupy i może subskrybować produkty widoczne w tych grupach.

Gdy deweloperzy subskrybują produkt, otrzymują podstawowy i pomocniczy klucz produktu do użycia podczas wywoływania interfejsów API produktu.

Więcej informacji:

Obszary robocze

Obszary robocze umożliwiają zespołom deweloperów zdecentralizowanych interfejsów API zarządzanie własnymi interfejsami API i tworzenie ich produktów, a centralny zespół ds. platformy interfejsu API utrzymuje infrastrukturę usługi API Management. Każdy obszar roboczy zawiera interfejsy API, produkty, subskrypcje i powiązane jednostki, które są dostępne tylko dla współpracowników obszaru roboczego. Dostęp jest kontrolowany za pośrednictwem kontroli dostępu opartej na rolach (RBAC) platformy Azure.

Więcej informacji:

Zasady

Dzięki zasadom wydawca interfejsu API może zmienić zachowanie interfejsu API za pomocą konfiguracji. Zasady to zbiór instrukcji, które są wykonywane sekwencyjnie podczas żądania lub odpowiedzi interfejsu API. Popularne instrukcje obejmują konwersję formatu z xml na JSON i ograniczanie szybkości wywołań w celu ograniczenia liczby wywołań przychodzących od dewelopera. Aby uzyskać pełną listę, zobacz Api Management policies (Zasady usługi API Management).

Wyrażenia zasad mogą służyć jako wartości atrybutów lub wartości tekstowe w dowolnej z zasad usługi API Management, o ile w zasadach nie określono inaczej. Niektóre zasady, np. Przepływ sterowania i Ustawianie zmiennej, są oparte na wyrażeniach zasad.

Zasady można stosować w różnych zakresach, w zależności od potrzeb: globalnych (wszystkich interfejsów API), obszaru roboczego, produktu, określonego interfejsu API lub operacji interfejsu API.

Więcej informacji:

Następne kroki

Wykonaj procedury przedstawione w następującym przewodniku Szybki Start i zacznij korzystać z usługi Azure API Management: