Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info
Apigee Edge umożliwia szybkie udostępnianie usług backendu jako interfejsów API. W tym celu należy utworzyć serwer proxy interfejsu API, który stanowi fasadę usługi backendu, którą chcesz udostępnić. Wystarczy, że podasz adres sieciowy usługi backendowej oraz informacje, których Edge używa do utworzenia serwera proxy interfejsu API udostępnianego deweloperom.
Proxy interfejsu API oddziela implementację usługi backendowej od interfejsu API, którego używają deweloperzy. Dzięki temu deweloperzy nie muszą martwić się o przyszłe zmiany w serwisach backendowych. Gdy aktualizujesz usługi backendu, deweloperzy nie muszą się martwić o te zmiany, aby nadal wywoływać interfejs API bez zakłóceń.
Obejrzyj ten film, aby dowiedzieć się więcej o tworzeniu proxy interfejsu API.
Tworzenie proxy interfejsu API za pomocą interfejsu użytkownika
Najłatwiejszym sposobem utworzenia serwera proxy interfejsu API jest użycie kreatora tworzenia serwera proxy.
Edge
Aby uzyskać dostęp do kreatora tworzenia serwera proxy za pomocą interfejsu Edge:
- Zaloguj się na stronie apigee.com/edge.
- Na pasku nawigacyjnym po lewej stronie kliknij Rozwijaj > Proxy interfejsu API.
- Kliknij +Proxy.
Kreator tworzenia proxy wyświetla instrukcje tworzenia i dodawania minimalnych funkcji do proxy interfejsu API.
Classic Edge (Private Cloud)
Aby uzyskać dostęp do kreatora tworzenia serwera proxy za pomocą interfejsu klasycznej wersji Edge:
- Zaloguj się na stronie
http://ms-ip:9000
, gdzie ms-ip to adres IP lub nazwa DNS węzła serwera zarządzania. - Na górnym pasku nawigacyjnym kliknij Interfejsy API > Proxy interfejsów API.
- Kliknij + Serwer proxy API.
Kreator tworzenia serwera proxy przedstawia kroki wymagane do wygenerowania serwera proxy interfejsu API i dodania do niego minimalnych funkcji.
Na pierwszej stronie kreatora możesz utworzyć serwer proxy API z tych źródeł:
Typ | Opis |
---|---|
Odwrotny serwer proxy (najczęstszy) |
Serwer proxy interfejsu API, który kieruje przychodzące żądania do istniejących usług backendu HTTP. Może to być interfejs API JSON lub XML. W dalszej części tej sekcji znajdziesz instrukcje tworzenia serwera proxy odwrotnego dla usługi HTTP. Kliknij Użyj specyfikacji OpenAPI, aby wygenerować serwer proxy na podstawie prawidłowej specyfikacji OpenAPI. Więcej informacji o tej opcji znajdziesz w sekcji Generowanie proxy za pomocą specyfikacji OpenAPI. |
Usługa SOAP | Serwer proxy interfejsu API wygenerowany na podstawie pliku WSDL. Zobacz artykuł Udostępnianie usługi internetowej opartej na protokole SOAP jako serwer proxy interfejsu API. |
Brak celu |
Serwer proxy interfejsu API bez backendu interfejsu API („bez docelowego interfejsu API”). Podobnie jak w przypadku opisanej wcześniej tworzenia odwrotnego serwera proxy dla usługi HTTP, z tą różnicą, że podczas określania szczegółów serwera proxy interfejsu API nie podasz istniejącego interfejsu API. Kliknij Użyj specyfikacji OpenAPI, aby wygenerować serwer proxy na podstawie prawidłowej specyfikacji OpenAPI. Więcej informacji o tej opcji znajdziesz w sekcji Generowanie proxy za pomocą specyfikacji OpenAPI. |
Hostowany cel |
Proxy interfejsu API, które kieruje do aplikacji Node.js wdrożonej w środowisku hostowanych celów. Zapoznaj się z omówieniem celów hostowanych. |
Przesyłanie pakietu proxy | istniejący pakiet proxy interfejsu API (np. jeden z przykładowych proxy interfejsów API dostępnych na GitHubie); Zobacz Importowanie proxy interfejsu API z paczki proxy interfejsu API. |
W poniższych sekcjach znajdziesz instrukcje tworzenia serwera proxy interfejsu API za pomocą poszczególnych źródeł.
Tworzenie odwrotnego serwera proxy dla usługi HTTP
Edge generuje odwrotne serwery proxy na podstawie 2 informacji:
- Adres URL usługi backendu
- Ścieżka URI jednoznacznie identyfikująca interfejs API, który będzie udostępniany przez serwer proxy interfejsu API aplikacjom użytkownika
Adres URL usługi backendu zwykle reprezentuje aplikację obsługującą usługę należącą do Twojej organizacji. Może też wskazywać na publicznie dostępny interfejs API. Interfejs API lub usługa mogą być pod Twoją kontrolą (np. wewnętrzna aplikacja HR lub aplikacja Rails w chmurze) lub mogą być interfejsem API lub usługą innej firmy (np. Twitter lub Instagram).
Edge
- Otwórz kreatora tworzenia serwera proxy zgodnie z opisem w sekcji Tworzenie serwera proxy interfejsu API za pomocą interfejsu powyżej w tej sekcji.
- W kreatorze tworzenia serwera proxy kliknij Serwer proxy odwrotny (najczęściej używany). Aby wygenerować proxy na podstawie istniejącej, ważnej specyfikacji OpenAPI, kliknij Użyj specyfikacji OpenAPI. Szczegółowe informacje o tej opcji znajdziesz w sekcji Generowanie proxy za pomocą specyfikacji OpenAPI.
- Na stronie Szczegóły kreatora podaj te informacje.
Pole Opis Nazwa Wyświetlana nazwa interfejsu API. Podaj znaki alfanumeryczne, łącznik (-) lub podkreślenie (_). Ścieżka podstawowa Fragment URI, który pojawia się po adresie http(s)://[host] serwera proxy API. Edge używa identyfikatora URI ścieżki podstawowej do dopasowywania przychodzących wiadomości żądań i przekierowywania ich do odpowiedniego serwera proxy interfejsu API.
UWAGA: ścieżka podstawowa serwera proxy interfejsu API jest domyślnie ustawiona na wartość określoną w polu
Name
, ale w wersji z małą litery.Po ścieżce podstawowej znajdują się wszelkie dodatkowe adresy URL zasobów. Oto pełną strukturę adresów URL, której klienty będą używać do wywoływania serwera proxy interfejsu API:
https://[host]/base_path/conditional_flow_path
UWAGA: ścieżka podstawowa musi być unikalna. Nie można wdrożyć 2 przekaźników interfejsu API z tą samą ścieżką podstawową. Jeśli edytujesz wdrożony serwer proxy interfejsu API i ustawiasz ścieżkę podstawową na taką samą jak ścieżka podstawowa innego serwera proxy interfejsu API, Edge automatycznie wycofuje serwer proxy interfejsu API po zapisaniu. Zanim ponownie wdrożysz serwer proxy interfejsu API, musisz zmienić ścieżkę podstawową, aby była unikalna.
Używanie symboli wieloznacznych w ścieżkach podstawowych
Użyj co najmniej 1 symbolu zastępczego
/*/
w ścieżkach podstawowych serwerów proxy interfejsu API, aby zapewnić ich zgodność z przyszłością. Na przykład ścieżka podstawowa/team/*/members
umożliwia klientom wywoływaniehttps://[host]/team/blue/members
ihttps://[host]/team/green/members
bez konieczności tworzenia nowych serwerów proxy interfejsów API na potrzeby obsługi nowych zespołów. Uwaga:/**/
nie jest obsługiwany.Opis (Opcjonalnie) Opis interfejsu API. Cel (istniejący interfejs API) Adres URL usługi backendu wywoływanej przez ten serwer proxy API. - Na stronie Typowe zasady w kreatorze skonfiguruj te ustawienia:
- Wymagania dotyczące autoryzacji zabezpieczeń w sekcji Bezpieczeństwo: autoryzacja. Zobacz Dodawanie zabezpieczeń w dalszej części tej sekcji.
- Obsługa udostępniania zasobów między domenami (CORS) w sekcji Zabezpieczenia: przeglądarka. Więcej informacji znajdziesz w sekcji Dodawanie obsługi CORS.
- Limity, które chronią usługę backendową przed dużym ruchem w ramach limitu. Zobacz artykuł Limity. (niedostępne, jeśli wybrana jest autoryzacja typu pass-through)
- Wdrożenie limitu zarabiania w organizacjach, które mają włączone zarabianie, w sekcji Zarabianie. Zobacz artykuł Wymuszanie limitów zarabiania na serwerach proxy API.
- Na stronie Hosty wirtualne kreatora wybierz hosty wirtualne, z którymi serwer proxy interfejsu API zostanie powiązany po wdrożeniu. Więcej informacji znajdziesz w artykule Informacje o hostach wirtualnych.
- Na stronie Podsumowanie wybierz w razie potrzeby środowisko(a) wdrożeniowe i kliknij Utwórz i wdróż.
Twoje nowe serwery proxy API są tworzone i wdrażane w wybranym środowisku.
- Kliknij Edytuj proxy, aby wyświetlić stronę szczegółów proxy API.
Classic Edge (Private Cloud)
- Otwórz kreatora tworzenia serwera proxy zgodnie z opisem w sekcji Tworzenie serwera proxy interfejsu API za pomocą interfejsu użytkownika.
- W kreatorze tworzenia serwera proxy wybierz Serwer proxy odwrotny (najczęściej używany). Aby wygenerować serwer proxy na podstawie istniejącej, prawidłowej specyfikacji OpenAPI, kliknij Użyj OpenAPI. Szczegółowe informacje o tej opcji znajdziesz w sekcji Generowanie proxy za pomocą specyfikacji OpenAPI.
- Kliknij Dalej.
- Na stronie Szczegóły kreatora podaj te informacje.
- Na stronie kreatora Bezpieczeństwo skonfiguruj te ustawienia:
- Wymagania dotyczące uwierzytelniania bezpieczeństwa. Więcej informacji znajdziesz w sekcji Dodawanie zabezpieczeń.
- Obsługa współdzielenia zasobów pomiędzy serwerami z różnych domen (CORS). Więcej informacji znajdziesz w sekcji Dodawanie obsługi CORS.
- Na stronie Hosty wirtualne kreatora wybierz hosty wirtualne, z którymi serwer proxy interfejsu API zostanie powiązany po wdrożeniu. Aby dowiedzieć się więcej, przeczytaj Informacje o hostach wirtualnych.
- Wybierz środowisko(-a) wdrożeniowe i kliknij Zbuduj i wdróż
.Wysłane zostanie potwierdzenie, że nowe proxy interfejsu API zostało utworzone i wdrożone w wybranym środowisku. - Kliknij Wyświetl w edytorze serwera proxy o nazwie <nazwa serwera proxy>, aby wyświetlić stronę z informacjami o serwerze proxy API.
Importowanie proxy interfejsu API z pakietu proxy interfejsu API
Serwery proxy interfejsów API często definiuje się jako zbiór plików XML i wszystkich innych plików pomocniczych. Definiując zastępcze interfejsy API jako zestaw plików zewnętrznych w usłudze Edge, możesz je utrzymywać w systemie kontroli źródłowej, a następnie importować do Edge na potrzeby testowania i wdrażania.
Obejrzyj ten film, aby dowiedzieć się, jak utworzyć i zaimportować proxy interfejsu API z pakietu proxy interfejsu API.
Edge
Aby zaimportować proxy interfejsu API z pakietu proxy interfejsu API:
- Otwórz kreatora tworzenia serwera proxy zgodnie z opisem w sekcji Tworzenie serwera proxy interfejsu API za pomocą interfejsu użytkownika.
- Kliknij Prześlij pakiet proxy.
- Na stronie Prześlij pakiet proxy w kreatorze proxy podaj te informacje.
Pole Opis Pakiet ZIP Plik ZIP zawierający konfigurację serwera proxy interfejsu API. Przeciągnij i upuść lub kliknij, aby przejść do pliku. Nazwa Wyświetlana nazwa interfejsu API. Domyślnie jest to nazwa pliku ZIP bez rozszerzenia. - Kliknij Dalej.
- Na stronie Podsumowanie wybierz w razie potrzeby środowisko(środowiska) wdrażania i kliknij Utwórz i wdróż
. Wyświetli się potwierdzenie, że nowy serwer proxy interfejsu API został utworzony. - Kliknij Edytuj proxy, aby wyświetlić stronę szczegółów proxy API.
Classic Edge (Private Cloud)
- Otwórz kreatora tworzenia serwera proxy zgodnie z opisem w sekcji Tworzenie serwera proxy interfejsu API za pomocą interfejsu powyżej w tej sekcji.
- W kreatorze tworzenia serwera proxy wybierz Pakiet serwera proxy.
- Kliknij Dalej.
- Na stronie Details (Szczegóły) w kreatorze serwera proxy wpisz te informacje.
Pole Opis Pakiet ZIP Kliknij Wybierz plik i otwórz plik ZIP zawierający konfigurację proxy API. Nazwa serwera proxy Wyświetlana nazwa interfejsu API. - Sprawdź informacje o kompilacji i kliknij Kompilacja.
Jeśli operacja się powiedzie, wyświetli się komunikat, a Edge automatycznie wdroży zaimportowane proxy interfejsu API w wybranym środowisku w Twojej organizacji. Interfejs API udostępniany przez serwer proxy interfejsu API jest dostępny do wywoływania. - Aby wyświetlić stronę z informacjami o pośrednim serwerze API, w edytorze kliknij Wyświetl pośredni serwer API <nazwa pośredniego serwera API>.
- Aby wdrożyć serwer proxy, kliknij menu Wdrożenie, wybierz środowisko, w którym chcesz przeprowadzić wdrożenie, i odpowiedz na prompt.
Udostępnianie usługi WWW opartej na protokole SOAP jako serwera proxy interfejsu API
W kreatorze tworzenia usługi proxy kliknij Usługa SOAP i postępuj zgodnie z instrukcjami kreatora, aby utworzyć usługę proxy typu pass-through lub opartą na protokole REST dla usługi SOAP. Szczegółowe informacje znajdziesz w artykule Wyświetlanie usługi SOAP jako serwera pośredniczącego interfejsu API.
Dodawanie zabezpieczeń
Na stronie Wspólne zasady (Edge) lub Bezpieczeństwo (Edge w wersji klasycznej) w kreatorze tworzenia proxy wybierz typ autoryzacji zabezpieczeń, który chcesz dodać. Tabela poniżej zawiera podsumowanie dostępnych opcji:
Autoryzacja zabezpieczeń | Opis |
---|---|
Klucz interfejsu API | Dodaje prostą weryfikację klucza interfejsu API do zdefiniowanego serwera proxy interfejsu API. W odpowiedzi na to platforma API dodaje do Twojego serwera proxy interfejsu API zasady VerifyAPIKey i AssignMessage. Zasada VerifyAPIKey weryfikuje klucze interfejsu API podawane przez aplikacje przesyłające żądania. Polityka przypisywania wiadomości usuwa z żądania przekazywanego do serwera backendu klucz interfejsu API podany w wywołaniu interfejsu API jako parametr zapytania. |
OAuth 2.0 | Dodaje uwierzytelnianie OAuth 2.0 do Twojego serwera proxy API. Apigee Edge automatycznie dodaje do proxy interfejsu API 2 zasady: jedną do weryfikacji tokena dostępu i drugą do usuwania tokena dostępu z wiadomości przed przekazaniem jej do usługi backendowej. Aby dowiedzieć się, jak uzyskać token dostępu, przeczytaj sekcję OAuth. |
Przepuszczenie (bez autoryzacji) | Nie wymaga autoryzacji. Żądania są przekazywane do backendu bez żadnych kontroli bezpieczeństwa w Apigee Edge. |
Dodawanie obsługi CORS
CORS (Udostępnianie zasobów między domenami) to standardowy mechanizm, który umożliwia przeglądarce internetowej wysyłanie bezpośrednich żądań do innej domeny. Standard CORS definiuje zestaw nagłówków HTTP, których przeglądarki i serwery używają do wdrażania komunikacji między domenami.
Możesz dodać obsługę CORS do swojego interfejsu API, wybierając Dodaj nagłówki CORS na stronie Wspólne zasady (Edge) lub Bezpieczeństwo (Edge klasyczny) kreatora tworzenia proxy.
Więcej szczegółowych informacji o obsługiwaniu CORS, w tym o dodawaniu obsługi wstępnej CORS do serwera proxy, znajdziesz w artykule Dodawanie obsługi CORS do serwera proxy API.
Generowanie serwerów proxy za pomocą specyfikacji OpenAPI
W tej sekcji omówiono opcję Użyj OpenAPI, która umożliwia wygenerowanie na podstawie specyfikacji OpenAPI następujących typów serwerów proxy interfejsu API: odwrotnego, Node.js lub bez celu.
Co to jest specyfikacja OpenAPI?
„Inicjatywa Open API (OAI) koncentruje się na tworzeniu, rozwijaniu i promowaniu formatu opisu interfejsu API neutralnego dla dostawcy na podstawie specyfikacji Swagger”. Więcej informacji o inicjatywie Open API znajdziesz na stronie https://openapis.org.
Specyfikacja OpenAPI wykorzystuje standardowy format do opisu interfejsu API REST. Specyfikacja OpenAPI jest napisana w formacie JSON lub YAML, dzięki czemu jest czytelna dla maszyn, ale też łatwa do odczytania i zrozumienia przez ludzi. Specyfikacja opisuje takie elementy interfejsu API, takie jak jego ścieżka bazowa, ścieżki i czasowniki, nagłówki, parametry zapytania, operacje, typy treści, opisy odpowiedzi i inne. Ponadto specyfikacja OpenAPI jest często używana do generowania dokumentacji interfejsu API.
Oto fragment specyfikacji OpenAPI, która opisuje mockową usługę docelową Apigee: http://mocktarget.apigee.net. Więcej informacji znajdziesz na stronie https://github.com/apigee/api-platform-samples/tree/master/default-proxies/helloworld/openapi.
openapi: 3.0.0 info: description: OpenAPI Specification for the Apigee mock target service endpoint. version: 1.0.0 title: Mock Target API paths: /: get: summary: View personalized greeting operationId: View a personalized greeting description: View a personalized greeting for the specified or guest user. parameters: - name: user in: query description: Your user name. required: false schema: type: string responses: "200": description: Success /help: get: summary: Get help operationId: Get help description: View help information about available resources in HTML format. responses: "200": description: Success ...
Za pomocą kreatora tworzenia proxy możesz zaimportować specyfikację OpenAPI i użyć jej do wygenerowania proxy API. Po wygenerowaniu proxy możesz go dalej rozwijać za pomocą interfejsu Edge, dodając zasady, implementując kod niestandardowy itp., tak jak w przypadku dowolnego proxy Edge.
Tworzenie serwera proxy interfejsu API na podstawie specyfikacji OpenAPI
Tworzenie proxy interfejsu API na podstawie specyfikacji OpenAPI. Wystarczy kilka kliknięć, aby utworzyć serwer proxy interfejsu API ze ścieżkami, parametrami, przepływami warunkowymi i docelowymi punktami końcowymi generowanymi automatycznie. Następnie możesz dodać funkcje, takie jak zabezpieczenia OAuth, ograniczanie liczby żądań i buforowanie.
W kreatorze tworzenia serwera proxy kliknij Użyj specyfikacji OpenAPI i postępuj zgodnie z instrukcjami kreatora, aby utworzyć odwrotny serwer proxy lub brak docelowego serwera proxy na podstawie specyfikacji OpenAPI. Szczegółowe informacje znajdziesz w artykule Tworzenie serwera proxy interfejsu API na podstawie specyfikacji OpenAPI.
Obejrzyj ten film, aby dowiedzieć się, jak utworzyć proxy interfejsu API na podstawie specyfikacji OpenAPI.
Aktualizowanie przepływów w proxy interfejsu API za pomocą specyfikacji OpenAPI
Po utworzeniu za pomocą specyfikacji OpenAPI serwera proxy interfejsu API, jeśli zmodyfikujesz specyfikację, aby dodać dodatkowe ścieżki zasobów, możesz użyć tej specyfikacji, aby dodać do serwera proxy powiązane przepływy warunkowe.
Aby zaktualizować przepływy w proxy interfejsu API za pomocą specyfikacji OpenAPI:
- Dodaj nowe ścieżki zasobów do specyfikacji OpenAPI. Zobacz Edytowanie istniejącej specyfikacji OpenAPI.
- Otwórz interfejs API Proxy w interfejsie użytkownika i kliknij kartę Opracowywanie.
- W nawigatorze kliknij + obok punktu końcowego serwera proxy, który chcesz zaktualizować.
Otworzy się okno Nowy przepływ warunkowy. - Kliknij Z OpenAPI, jeśli nie jest już wybrana.
Jeśli w specyfikacji OpenAPI są zasoby, które nie mają odpowiadającego im przepływu warunkowego w interfejsie API, są one wymienione w oknie dialogowym, jak pokazano na rysunku poniżej. - Wybierz zasoby, do których chcesz dodać przepływ warunkowy.
- Kliknij Dodaj.
Przepływy warunkowe są dodawane do Twojego serwera proxy API.
Tworzenie nowej wersji serwera proxy interfejsu API
Utwórz nową wersję proxy interfejsu API, jak opisano poniżej.
Edge
Aby utworzyć nową wersję proxy interfejsu API za pomocą interfejsu Edge:
- Zaloguj się na stronie apigee.com/edge.
- Na pasku nawigacyjnym po lewej stronie kliknij Rozwijaj > Proxy interfejsu API.
- Na liście kliknij serwer proxy interfejsu API, który chcesz skopiować.
- Wybierz Projekt > Zapisz jako nową wersję.
Classic Edge (Private Cloud)
Aby utworzyć nową wersję proxy interfejsu API za pomocą interfejsu klasycznej wersji przeglądarki Edge:
- Zaloguj się na stronie
http://ms-ip:9000
, gdzie ms-ip to adres IP lub nazwa DNS węzła serwera zarządzania. - Na górnym pasku nawigacyjnym kliknij Interfejsy API > Proxy interfejsów API.
- Na liście kliknij serwer proxy interfejsu API, który chcesz skopiować.
- Wybierz Projekt > Zapisz jako nową wersję.
Kopiuję serwer proxy interfejsu API
Skopiuj istniejący proxy interfejsu API do nowego proxy interfejsu API, jak opisano poniżej.
Edge
Aby skopiować serwer proxy interfejsu API za pomocą interfejsu użytkownika Edge:
- Zaloguj się na stronie apigee.com/edge.
- Na pasku nawigacyjnym po lewej stronie kliknij Rozwijaj > Proxy interfejsu API.
- Na liście kliknij serwer proxy interfejsu API, który chcesz skopiować.
- Kliknij Projekt > Zapisz jako nowy serwer proxy API.
- W oknie Zapisz jako nowy serwer proxy wpisz nazwę nowego serwera proxy interfejsu API.
- Kliknij Dodaj.
Classic Edge (Private Cloud)
Aby skopiować serwer proxy API za pomocą interfejsu klasycznej wersji przeglądarki Edge:
- Zaloguj się na stronie
http://ms-ip:9000
, gdzie ms-ip to adres IP lub nazwa DNS węzła serwera zarządzania. - Na górnym pasku nawigacyjnym kliknij Interfejsy API > Proxy interfejsów API.
- Na liście kliknij serwer proxy interfejsu API, który chcesz skopiować.
- Kliknij Projekt > Zapisz jako nowy serwer proxy API.
- W oknie Zapisz jako nowy serwer proxy wpisz nazwę nowego serwera proxy interfejsu API.
- Kliknij Dodaj.
Tworzenie kopii zapasowej proxy interfejsu API
Możesz utworzyć kopię zapasową istniejącego serwera proxy interfejsu API jako zestawu plików XML w pakiecie serwera proxy interfejsu API. Po wyeksportowaniu do pakietu możesz zaimportować serwer proxy interfejsu API do nowego serwera, zgodnie z opisem w sekcji Importowanie serwera proxy interfejsu API z pliku pakietu serwera proxy interfejsu API. Więcej informacji znajdziesz w artykule Pobieranie proxy interfejsów API.
Tworzenie serwera proxy interfejsu API przy użyciu interfejsu API
Aby dowiedzieć się, jak utworzyć serwer proxy interfejsu API za pomocą interfejsu API, przeczytaj sekcję API serwerów proxy interfejsu API.