Odnajdywanie usługi API Management
Usługa API Management zapewnia podstawowe funkcje zapewniające pomyślny program interfejsu API dzięki zaangażowaniu deweloperów, analizom biznesowym, analizie, bezpieczeństwu i ochronie. Każdy interfejs API składa się z co najmniej jednej operacji i można go dodać do co najmniej jednego produktu. Aby użyć interfejsu API, deweloperzy subskrybują produkt zawierający ten interfejs API, a następnie mogą wywołać operację interfejsu API, z zastrzeżeniem wszelkich zasad użycia, które mogą obowiązywać.
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.
Brama interfejsu API to punkt końcowy, który ma następujące zastosowania:
- Akceptuje wywołania interfejsu API i kieruje je do odpowiednich zapleczy
- Weryfikuje klucze interfejsu API i inne poświadczenia prezentowane z żądaniami
- Wymusza limity przydziału użycia i limity szybkości
- Przekształca żądania i odpowiedzi określone w instrukcjach zasad
- Buforuje odpowiedzi w celu zwiększenia opóźnienia odpowiedzi i zminimalizowania obciążenia usług zaplecza
- Emituje dzienniki, metryki i ślady na potrzeby monitorowania, raportowania i rozwiązywania problemów
Płaszczyzna zarządzania to interfejs administracyjny, w którym konfigurujesz program interfejsu API. Jego zastosowania to:
- Aprowizuj i konfiguruj ustawienia usługi API Management
- Definiowanie lub importowanie schematu interfejsu API
- 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 to automatycznie generowana, w pełni dostosowywalna witryna internetowa z dokumentacją interfejsów API. 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
Produkty
Produkty stanowią sposób udostępniania interfejsów API deweloperom. Produkty w usłudze API Management mają co najmniej jeden interfejs API oraz skonfigurowany tytuł, opis i warunki użytkowania. Produkty mogą być otwarte lub chronione. Produkty chronione trzeba subskrybować przed użyciem, a produkty otwarte mogą być używane bez subskrypcji. Zatwierdzenie subskrypcji jest konfigurowane na poziomie produktu i może wymagać zatwierdzenia przez administratora lub być automatycznie zatwierdzane.
Grupy
Grupy służą do zarządzania widocznością produktów dla deweloperów. Usługa API Management ma następujące niezmienne grupy systemowe:
- Administratorzy — 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 nieuwierzytelnionych. Mogą mieć dostęp tylko do odczytu, taki jak możliwość wyświetlania interfejsów API, ale nie ich wywoływania.
Oprócz tych grup systemowych administratorzy mogą tworzyć grupy niestandardowe lub używać grup zewnętrznych w skojarzonych dzierżawach firmy Microsoft.
Deweloperzy
Deweloperzy reprezentują konta użytkowników w wystąpieniu usługi API Management. Konta deweloperów mogą być tworzone lub dołączane na zaproszenie administratorów. Ponadto deweloperzy mogą się zarejestrować w Portalu dla deweloperów. Każdy deweloper jest członkiem co najmniej jednej grupy i może subskrybować produkty widoczne w tych grupach.
Zasady
Zasady to zbiór instrukcji, które są wykonywane sekwencyjnie podczas żądania lub odpowiedzi interfejsu API. Popularne instrukcje obejmują konwersję z formatu XML na format JSON i ograniczanie liczby wywołań, aby zmniejszyć liczbę wywołań przychodzących od dewelopera. Ponadto dostępnych jest wiele innych zasad.
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), produktu, określonego interfejsu API lub operacji interfejsu API.