Interfejsy API i serwery proxy interfejsów API

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info

Apigee Edge umożliwia łatwe i szybkie tworzenie interfejsów API typu REST, z których mogą korzystać programiści aplikacji. Interfejsy API udostępniasz w Edge, tworząc proxy interfejsów API, które działają jako zarządzane „fasady” usług backendu. W tym artykule omawiamy relację między interfejsami API a proxy interfejsów API w Apigee Edge.

Film: obejrzyj ten krótki film, aby dowiedzieć się więcej o proxy interfejsów API.

Co to jest interfejs API?

Interfejs API to interfejs, który ułatwia jednej aplikacji „korzystanie” z funkcji lub danych innej aplikacji. Dzięki definiowaniu stabilnych, uproszczonych punktów wejścia do logiki aplikacji i danych interfejsy API umożliwiają programistom łatwy dostęp do logiki aplikacji utworzonej przez innych programistów i jej ponowne wykorzystanie. W przypadku „interfejsów API sieciowych” ta logika i dane są udostępniane w sieci.

Ponieważ aplikacje korzystające z interfejsów API są wrażliwe na zmiany, interfejsy API implikują też „umowę”. Umowa zapewnia pewien poziom pewności, że z czasem interfejs API będzie się zmieniać w a przewidywalny sposób.

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

Edge umożliwia też tworzenie interfejsów API przez implementowanie aplikacji hostowanych na platformie API Services – bez udziału usługi backendu. Te aplikacje możesz tworzyć w JavaScript, Javie, i Node.js.

Co to jest proxy interfejsu API?

Interfejsy API udostępniasz w Apigee Edge, implementując proxy interfejsów API. Proxy interfejsów API oddzielają interfejs API widoczny dla aplikacji od usług backendu, chroniąc te aplikacje przed zmianami w kodzie backendu. Gdy wprowadzisz zmiany w usługach backendu, aplikacje będą nadal wywoływać ten sam interfejs API bez żadnych przerw.

W konfiguracji proxy interfejsu API występują 2 typy punktów końcowych:

  • ProxyEndpoint: określa sposób, w jaki aplikacje klienckie korzystają z Twoich interfejsów API. Konfigurujesz ProxyEndpoint, aby określić adres URL proxy interfejsu API. Punkt końcowy proxy określa też, czy aplikacje uzyskują dostęp do proxy interfejsu API przez HTTP czy HTTPS. Zwykle do ProxyEndpoint dołączasz zasady, aby wymuszać zabezpieczenia, sprawdzać limity i stosować inne typy kontroli dostępu oraz ograniczania liczby żądań.
  • TargetEndpoint: określa sposób, w jaki proxy interfejsu API współdziała z usługami backendu. Konfigurujesz TargetEndpoint, aby przekazywać żądania do odpowiedniej usługi backendu, w tym określać ustawienia zabezpieczeń, protokół HTTP lub HTTPS oraz inne informacje o połączeniu. Do TargetEndpoint możesz dołączyć zasady, aby mieć pewność, że komunikaty odpowiedzi są prawidłowo sformatowane dla aplikacji, która wysłała pierwotne żądanie.

Proxy interfejsów API możesz wizualizować tak jak na ilustracji poniżej:

Żądania HTTP wchodzą 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 są przesyłane przez docelowy punkt końcowy odpowiedzi, przekazywane do punktu końcowego odpowiedzi serwera proxy, a następnie z powrotem do klienta.

Jak utworzyć proxy interfejsu API?

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 proxy interfejsów API, m.in.:

  • Używanie interfejsu zarządzania Edge do definiowania proxy interfejsu API w graficznym interfejsie użytkownika (GUI). Więcej informacji znajdziesz w artykule Tworzenie prostego proxy interfejsu API.
  • Tworzenie plików XML wraz z innymi plikami pomocniczymi, które definiują proxy interfejsu API, a następnie importowanie ich do Edge.
  • Używanie interfejsu API zarządzania Edge do tworzenia proxy interfejsów API przez wysyłanie serii żądań REST do Edge.
  • Wdrażanie aplikacji Node.js jako proxy. Więcej informacji znajdziesz w artykule Wdrażanie samodzielnej aplikacji Node.js app.

Co to jest zasada?

Edge umożliwia kontrolowanie działania interfejsu API bez pisania kodu za pomocą zasad. Zasada jest jak moduł, który implementuje konkretną, ograniczoną funkcję zarządzania w ramach przepływu żądania/odpowiedzi proxy. Zasady umożliwiają łatwe i niezawodne dodawanie do interfejsu API typowych funkcji zarządzania. Zasady zapewniają funkcje takie jak zabezpieczenia, ograniczanie liczby żądań, transformacja i mediacja, dzięki czemu nie musisz samodzielnie kodować i utrzymywać tych funkcji.

Utwórz pierwsze proxy interfejsu API

Apigee udostępnia zestaw samouczków, które pomogą Ci utworzyć pierwszy interfejs API. Zacznij od samouczka Tworzenie pierwszego proxy interfejsu API.

Dobrym sposobem na poznanie proxy interfejsów API jest praca z przykładami opisanymi w artykule Korzystanie z przykładowych proxy interfejsów API.

Więcej informacji