Interfejsy API i serwery proxy interfejsów API

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X.
Informacje

Apigee Edge umożliwia łatwe i szybkie tworzenie interfejsów API typu REST, z których mogą korzystać deweloperzy aplikacji. Interfejsy API możesz ujawniać w Edge, tworząc serwery proxy interfejsów API, które działają jako zarządzane „fasady” usług backendu. W tym temacie omawiamy relację między interfejsami API a serwerami proxy interfejsów API w Apigee Edge.

Film: obejrzyj ten krótki film wprowadzający do interfejsów API serwerów proxy.

Co to jest interfejs API?

Interfejs API to interfejs, który ułatwia jednej aplikacji korzystanie z funkcji lub danych z innej aplikacji. Definiując stabilne, uproszczone punkty wejścia do logiki i danych aplikacji, interfejsy API umożliwiają programistom łatwy dostęp do logiki aplikacji opracowanej przez innych deweloperów i ponowne używanie ich. W przypadku internetowych interfejsów API ta logika i dane są udostępniane przez sieć.

Aplikacje korzystające z interfejsów API są wrażliwe na zmiany, więc interfejsy API również wymagają „umowy”. Umowa daje pewną pewność, że interfejs API z czasem zmieni się w przewidywalny sposób.

Apigee Edge umożliwia tworzenie interfejsów API, a jeśli masz już interfejsy API, możesz je udostępniać bezpośrednio, dodając warstwę zarządzania i widoczności. Jeśli masz usługi z włączonym protokołem HTTP, takie jak usługi internetowe oparte na SOA, mogą one być też widoczne jako interfejsy API przez Apigee Edge.

Edge umożliwia też tworzenie interfejsów API przez implementowanie aplikacji hostowanych na platformie usług API – bez konieczności korzystania z usługi backendu. Te aplikacje możesz tworzyć w językach JavaScript, Javie i w Node.js.

Czym jest serwer proxy interfejsu API?

Udostępnij interfejsy API w Apigee Edge przez wdrożenie serwerów proxy interfejsów API. Serwery proxy interfejsów API odłączają interfejs API przeznaczony do aplikacji od usług backendu, chroniąc te aplikacje przed zmianami kodu backendu. Gdy wprowadzisz zmiany w usługach w backendzie, aplikacje będą nadal wywoływać ten sam interfejs API bez zakłóceń.

W konfiguracji serwera proxy interfejsu API są 2 typy punktów końcowych:

  • ProxyEndpoint: określa sposób korzystania z interfejsów API przez aplikacje klienckie. Możesz skonfigurować ProxyEndpoint na potrzeby zdefiniowania adresu URL serwera proxy interfejsu API. Punkt końcowy serwera proxy określa też, czy aplikacje mają dostęp do serwera proxy interfejsu API przez HTTP czy HTTPS. Zazwyczaj do punktu ProxyEndpoint dołącza się zasady, aby egzekwować bezpieczeństwo, sprawdzanie limitów i inne rodzaje kontroli dostępu i ograniczania liczby żądań.
  • TargetEndpoint: określa sposób interakcji serwera proxy interfejsu API z usługami backendu. Konfigurujesz punkt docelowy tak, aby przekazywał żądania do odpowiedniej usługi backendu. Obejmuje to definiowanie ustawień zabezpieczeń, protokołu HTTP lub HTTPS i innych informacji o połączeniu. Możesz dołączyć zasady do punktu końcowego docelowego, aby mieć pewność, że komunikaty z odpowiedziami są poprawnie sformatowane w przypadku aplikacji, która wysłała pierwotne żądanie.

Możesz zwizualizować serwery proxy API, tak jak na tej ilustracji:

Żądania HTTP przesyłane przez punkt końcowy żądania serwera proxy są przekazywane do docelowego punktu końcowego żądania, a następnie wysyłane do usług backendu. Odpowiedzi HTTP wprowadzane przez docelowy punkt końcowy odpowiedzi są przekazywane do punktu końcowego odpowiedzi serwera proxy, a następnie z powrotem do klienta.

Jak utworzyć serwer proxy interfejsu API?

Serwer proxy interfejsu API składa się z pakietu plików konfiguracyjnych XML i kodu (np. JavaScript i Java). Apigee udostępnia kilka sposobów tworzenia serwerów proxy interfejsów API, w tym:

  • Definiowanie serwera proxy interfejsu API w graficznym interfejsie użytkownika (GUI) przy użyciu interfejsu zarządzania brzegiem sieci. Więcej informacji znajdziesz w artykule o tworzeniu prostego serwera proxy interfejsu API.
  • Tworzenie plików XML i innych plików pomocniczych, które definiują serwer proxy interfejsu API, a następnie importowanie ich do Edge.
  • Użycie interfejsu Edge Management API do tworzenia serwerów proxy interfejsów API przez utworzenie serii żądań REST do Edge.
  • wdrożyć aplikację Node.js jako serwer proxy; Zapoznaj się z artykułem o wdrażaniu samodzielnej aplikacji Node.js.

Co to jest zasada?

Edge umożliwia kontrolowanie działania interfejsu API bez konieczności pisania kodu przy użyciu zasad. Zasada jest jak moduł, który implementuje określoną, ograniczoną funkcję zarządzania w ramach procesu wysyłania żądań i odpowiedzi serwera proxy. Zasady umożliwiają łatwe i niezawodne dodawanie do interfejsu API typowych typów funkcji zarządzania. Zasady zapewniają takie funkcje jak zabezpieczenia, ograniczanie liczby żądań, przekształcanie i funkcje zapośredniczenia, dzięki czemu nie musisz samodzielnie kodować i obsługiwać tych funkcji.

Utwórz pierwszy serwer proxy interfejsu API

Apigee udostępnia zestaw samouczków, z których możesz skorzystać, aby utworzyć swój pierwszy interfejs API. Zacznij od tworzenia pierwszego serwera proxy interfejsu API.

Doskonałym sposobem na zapoznanie się z serwerami proxy interfejsów API jest posługiwanie się przykładami w sposób opisany w artykule Korzystanie z przykładowych serwerów proxy interfejsu API.

Więcej informacji