Tworzenie bramy interfejsów API
Organizacje często muszą zapewnić partnerom dostęp do danych. Ten dostęp musi być kontrolowany i zarządzany.
W przykładzie z firmą obuwniczą sprzedawcy, którzy zaopatrują firmę NorthWind Shoes, muszą wiedzieć, ile zapasów mogą zamówić. Klienci lubią również wiedzieć dokładnie, kiedy otrzymają zamówienie.
Tutaj dowiesz się, jak działa usługa Azure API Management i jak skonfigurować bramę interfejsu API.
Azure API Management
Usługa Azure API Management jest hostowana w chmurze platformy Azure i jest umieszczona między interfejsami API a Internetem. Wystąpienie usługi API Management działa jako brama interfejsu API platformy Azure.
Podczas publikowania interfejsów API możesz kontrolować sposób uwidaczniania poszczególnych interfejsów API klientom przy użyciu witryny Azure Portal. Możesz chcieć, aby w celach demonstracyjnych deweloperzy mieli swobodny dostęp do niektórych interfejsów API, a z kolei do innych interfejsów API dostęp może być ściśle kontrolowany.
Dlaczego warto używać usługi API Management?
Usługa API Management zapewnia deweloperom szereg korzyści.
- Dokumentacja interfejsu API. Dokumentacja interfejsów API umożliwia klientom wywołującym szybkie integrowanie rozwiązań. Usługa API Management umożliwia szybkie uwidacznianie struktury interfejsu API do wywoływania klientów za pomocą nowoczesnych standardów, takich jak OpenAPI. Możesz mieć więcej niż jedną wersję interfejsu API. Mając wiele wersji, możesz przygotowywać aktualizacje aplikacji, ponieważ aplikacje nie muszą od razu korzystać z nowej wersji.
- Dostęp z ograniczeniem szybkości. Jeśli Twój interfejs API może potencjalnie uzyskiwać dostęp do dużych ilości danych, dobrym pomysłem jest ograniczenie szybkości, z jaką klienci mogą żądać danych. Ograniczenie szybkości pomaga utrzymać optymalny czas odpowiedzi dla każdego klienta. Usługa API Management umożliwia ustawianie limitów szybkości jako całości lub dla określonych klientów indywidualnych.
- Monitorowanie kondycji. Klienci zdalni korzystają z interfejsów API, więc zidentyfikowanie potencjalnych problemów lub błędów może być trudne. Usługa API Management umożliwia wyświetlanie odpowiedzi na błędy i plików dziennika oraz filtrowanie według typów odpowiedzi.
- Nowoczesne formaty, takie jak JSON. W ciągu lat wiele różnych formatów wymiany danych było używanych przez interfejsy API z xml do csv i wiele innych. Usługa API Management umożliwia udostępnianie tych formatów przy użyciu nowoczesnych modeli danych, takich jak JSON.
- Połączenia z dowolnym interfejsem API. W wielu firmach interfejsy API znajdują się w różnych krajach/regionach i używają różnych formatów. Usługa API Management umożliwia dodanie wszystkich tych różnych interfejsów API do jednego nowoczesnego interfejsu.
- Analiza. Kiedy opracowujesz interfejsy API, warto sprawdzić, jak często są one wywoływane i przez jakie systemy. Usługa API Management umożliwia wizualizację tych danych w witrynie Azure Portal.
- Zabezpieczenia. Podczas pracy z danymi systemowymi bezpieczeństwo ma zasadnicze znaczenie. Nieautoryzowane naruszenia mogą powodować w firmach utratę pieniędzy, reputacji i czasu potrzebnego na ponowne opracowanie kodu. Narzędzia zabezpieczeń, których można używać z usługą Azure API Management, obejmują autoryzację użytkownika OAuth 2.0 i integrację z identyfikatorem Entra firmy Microsoft.
- Warstwy cenowe. Usługa API Management oferuje warstwy z różnymi możliwościami przepływności żądań, umowy dotyczącej poziomu usług (SLA), izolacji sieci, elastyczności uaktualniania itd. Podczas tworzenia bramy usługi Azure API Management należy wybrać warstwę, która spełnia Twoje potrzeby.
Konfiguracja usługi API Management
Aby skonfigurować usługę API Management, należy wykonać następujące czynności:
- Tworzenie bramy usługi API Management. Nazwa użyta dla bramy musi być globalnie unikatowa w obrębie przestrzeni nazw .azure-api.net.
- Zarejestruj istniejący internetowy interfejs API w bramie. Zarejestrowanie interfejsu API udostępnia ten interfejs API klientom w punkcie końcowym <brama>.azure-api.net.
- Wywołanie istniejącego interfejsu API za pośrednictwem bramy. Użytkownicy mogą teraz wywoływać interfejs API pod adresem URL punktu końcowego.